Skip to content

Commit

Permalink
ci: use coatl-dev/workflows@v3 (#189)
Browse files Browse the repository at this point in the history
use Python 3.12 for tox
  • Loading branch information
cesarcoatl authored Feb 22, 2024
1 parent 94c2ec2 commit e7267fa
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 31 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion .github/workflows/pip-compile-upgrade.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion .github/workflows/pre-commit-autoupdate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,11 @@
# incendium

<!--- Badges --->
[![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/)
>
Expand All @@ -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

Expand Down Expand Up @@ -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`
Expand All @@ -89,29 +81,29 @@ 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
1. Enter **incendium** as the **Project Name**
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`

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

Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down

0 comments on commit e7267fa

Please sign in to comment.