From e7267fa8a9b38e36e60af22003ec92e21b7d4b56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9sar=20Rom=C3=A1n?= Date: Thu, 22 Feb 2024 09:14:00 -0800 Subject: [PATCH] ci: use coatl-dev/workflows@v3 (#189) use Python 3.12 for tox --- .github/workflows/ci.yml | 4 +-- .github/workflows/pip-compile-upgrade.yml | 2 +- .github/workflows/pr-build.yml | 2 +- .github/workflows/pre-commit-autoupdate.yml | 2 +- .github/workflows/publish.yml | 8 ++--- README.md | 34 ++++++++------------- tox.ini | 2 +- 7 files changed, 23 insertions(+), 31 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bffa22d..37b238e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -9,10 +9,10 @@ on: jobs: pre-commit: - uses: coatl-dev/workflows/.github/workflows/pre-commit.yml@v2 + uses: coatl-dev/workflows/.github/workflows/pre-commit.yml@v3 with: skip-hooks: 'pylint' pylint: needs: pre-commit - uses: coatl-dev/workflows/.github/workflows/pylint.yml@v2 + uses: coatl-dev/workflows/.github/workflows/pylint.yml@v3 diff --git a/.github/workflows/pip-compile-upgrade.yml b/.github/workflows/pip-compile-upgrade.yml index ba26c38..22af62d 100644 --- a/.github/workflows/pip-compile-upgrade.yml +++ b/.github/workflows/pip-compile-upgrade.yml @@ -7,7 +7,7 @@ on: jobs: pip-compile-upgrade: - uses: coatl-dev/workflows/.github/workflows/pip-compile-upgrade.yml@v2 + uses: coatl-dev/workflows/.github/workflows/pip-compile-upgrade.yml@v3 with: path: requirements.txt secrets: diff --git a/.github/workflows/pr-build.yml b/.github/workflows/pr-build.yml index 735bc51..166a9c6 100644 --- a/.github/workflows/pr-build.yml +++ b/.github/workflows/pr-build.yml @@ -13,4 +13,4 @@ on: jobs: tox: - uses: coatl-dev/workflows/.github/workflows/tox-docker.yml@v2 + uses: coatl-dev/workflows/.github/workflows/tox-docker.yml@v3 diff --git a/.github/workflows/pre-commit-autoupdate.yml b/.github/workflows/pre-commit-autoupdate.yml index a9e30d7..af2381a 100644 --- a/.github/workflows/pre-commit-autoupdate.yml +++ b/.github/workflows/pre-commit-autoupdate.yml @@ -7,7 +7,7 @@ on: jobs: pre-commit-autoupdate: - uses: coatl-dev/workflows/.github/workflows/pre-commit-autoupdate.yml@v2 + uses: coatl-dev/workflows/.github/workflows/pre-commit-autoupdate.yml@v3 with: skip-repos: 'flake8' secrets: diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 2f5440e..afe3d4a 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -7,26 +7,26 @@ on: jobs: pre-commit: - uses: coatl-dev/workflows/.github/workflows/pre-commit.yml@v2 + uses: coatl-dev/workflows/.github/workflows/pre-commit.yml@v3 with: skip-hooks: 'pylint' pylint: needs: pre-commit - uses: coatl-dev/workflows/.github/workflows/pylint.yml@v2 + uses: coatl-dev/workflows/.github/workflows/pylint.yml@v3 tox: needs: - pre-commit - pylint - uses: coatl-dev/workflows/.github/workflows/tox-docker.yml@v2 + uses: coatl-dev/workflows/.github/workflows/tox-docker.yml@v3 pypi-publish: needs: - pre-commit - pylint - tox - uses: coatl-dev/workflows/.github/workflows/pypi-upload.yml@v2 + uses: coatl-dev/workflows/.github/workflows/pypi-upload.yml@v3 with: python-version: '2.7' secrets: diff --git a/README.md b/README.md index 52eb6b1..bc5c443 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,11 @@ # incendium -[![GitHub contributors](https://img.shields.io/github/contributors/thecesrom/incendium)](https://github.com/thecesrom/incendium/graphs/contributors) +[![ci](https://github.com/ignition-incendium/incendium/actions/workflows/ci.yml/badge.svg)](https://github.com/ignition-incendium/incendium/actions/workflows/ci.yml) +![GitHub last commit (code)](https://img.shields.io/github/last-commit/ignition-incendium/incendium) +[![GitHub contributors](https://img.shields.io/github/contributors/ignition-incendium/incendium)](https://github.com/ignition-incendium/incendium/graphs/contributors) [![Downloads](https://pepy.tech/badge/incendium)](https://pepy.tech/project/incendium) -[![PyPI](https://img.shields.io/pypi/v/incendium)](https://pypi.org/project/incendium/) -![GitHub last commit (code)](https://img.shields.io/github/last-commit/thecesrom/incendium) -[![time tracker](https://wakatime.com/badge/github/thecesrom/incendium.svg)](https://wakatime.com/badge/github/thecesrom/incendium) -[![Sourcery](https://img.shields.io/badge/Sourcery-enabled-brightgreen)](https://sourcery.ai) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) -[![Imports: flake8](https://img.shields.io/badge/%20imports-flake8-%231674b1?style=flat&labelColor=ef8336)](https://flake8.pycqa.org/en/latest/) -[![Imports: pydocstyle](https://img.shields.io/badge/%20imports-pydocstyle-%231674b1?style=flat&labelColor=ef8336)](https://www.pydocstyle.org/en/stable/) -[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/PyCQA/pylint) -[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/thecesrom/incendium/code.svg)](https://results.pre-commit.ci/latest/github/thecesrom/incendium/code) -[![Join us on GitHub discussions](https://img.shields.io/badge/github-discussions-informational)](https://github.com/thecesrom/incendium/discussions) +[![Join us on GitHub discussions](https://img.shields.io/badge/github-discussions-informational)](https://github.com/ignition-incendium/incendium/discussions) >(/inˈken.di.um/) > @@ -24,18 +16,18 @@ :package: Package that extends and wraps some functions from Ignition's Scripting API. -For more information, please refer to the [Wiki](https://github.com/thecesrom/incendium/wiki). +For more information, please refer to the [Wiki](https://github.com/ignition-incendium/incendium/wiki). ## `incendium` Project -We have moved the `project` branch to its own repo, [`incendium-project`](https://github.com/thecesrom/incendium-project) +We have moved the `project` branch to its own repo, [`incendium-project`](https://github.com/ignition-incendium/incendium-project) ## Prerequisites Before you begin, ensure you have met the following requirements: * You have installed Python 2.7.18 ([download here](https://www.python.org/downloads/release/python-2718/)) -* You are familiar with [Ignition 8.1 System Functions](https://docs.inductiveautomation.com/display/DOC81/System+Functions) +* You are familiar with [Ignition 8.1 System Functions](https://docs.inductiveautomation.com/docs/8.1/appendix/scripting-functions) ## Installation and usage @@ -74,13 +66,13 @@ python2 -m pip uninstall incendium ### Downloading from releases -You may also download the code targeted to your desired version from the [releases page](https://github.com/thecesrom/incendium/releases) and add it as a dependency to your scripting project. +You may also download the code targeted to your desired version from the [releases page](https://github.com/ignition-incendium/incendium/releases) and add it as a dependency to your scripting project. #### Using as a dependency in PyCharm To include `incendium` as a dependency in PyCharm, you will need to attach it to your project. -1. Clone the repo or download from [releases](https://github.com/thecesrom/incendium/releases) +1. Clone the repo or download from [releases](https://github.com/ignition-incendium/incendium/releases) 2. With your project open where you want to include `incendium`, navigate to `File > Open` and select the `incendium` project folder 3. Choose `Attach` when prompted 4. Under the `incendium` project folder, right-click on the `src/` folder and choose `Mark Directory as > Sources Root` @@ -89,7 +81,7 @@ To include `incendium` as a dependency in PyCharm, you will need to attach it to To install incendium on your Gateway follow these steps: -1. Download **incendium.x.x.x.zip** from the [latest release](https://github.com/thecesrom/incendium/releases/latest) or from [Ignition Exchange](https://inductiveautomation.com/exchange/2104) +1. Download **incendium.x.x.x.zip** from the [latest release](https://github.com/ignition-incendium/incendium/releases/latest) or from [Ignition Exchange](https://inductiveautomation.com/exchange/2104) 1. Browse to your Ignition Gateway (version 8.0+) 1. Go to **Config > Projects** and click on **Import project...** 1. Click on **Choose File** and select the downloaded ZIP file @@ -97,7 +89,7 @@ To install incendium on your Gateway follow these steps: 1. If you're replacing a previous version, make sure to check Allow Overwrite 1. Click on **Import** -Alternatively you could follow the instructions for cloning the `project` branch directly into `$IGNITION_DIR/data/projects` found [here](https://github.com/thecesrom/incendium/tree/project#cloning-this-branch). +Alternatively you could follow the instructions for cloning the `project` branch directly into `$IGNITION_DIR/data/projects` found [here](https://github.com/ignition-incendium/incendium/tree/project#cloning-this-branch). ## Contributing to `incendium` @@ -105,13 +97,13 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md). ## Discussions -Feel free to post your questions and/or ideas at [Discussions](https://github.com/thecesrom/incendium/discussions). +Feel free to post your questions and/or ideas at [Discussions](https://github.com/ignition-incendium/incendium/discussions). ## Contributors Thanks to everyone who has contributed to this project. -Up-to-date list of contributors can be found [here](https://github.com/thecesrom/incendium/graphs/contributors). +Up-to-date list of contributors can be found [here](https://github.com/ignition-incendium/incendium/graphs/contributors). ## License diff --git a/tox.ini b/tox.ini index ad03dd2..43987d0 100644 --- a/tox.ini +++ b/tox.ini @@ -53,7 +53,7 @@ allowlist_externals = base_python = python2.7 [py3] -base_python = python3.11 +base_python = python3.12 [type] base_python = {[py3]base_python}