|
1 | | -Github Workflows |
| 1 | +GitHub Workflows |
2 | 2 | ================ |
3 | 3 |
|
4 | | -The exasol-toolbox ships with various GitHub workflows. By default, we suggest installing all of them, |
5 | | -while the core workflows are: |
| 4 | +.. figure:: ../_static/github-workflows.png |
| 5 | + :alt: GitHub Workflow Example |
6 | 6 |
|
7 | | -**Workflows**: |
| 7 | +The exasol-toolbox ships with various GitHub workflow templates. To leverage the full feature set of the toolbox, you should use them. |
8 | 8 |
|
9 | | -* CI |
10 | | - Verifies PRs and regularly checks the project. |
| 9 | +.. attention:: |
11 | 10 |
|
12 | | -* CD |
13 | | - Publishes releases of the project. |
| 11 | + Generally, it is advised to install/use all workflows provided by the toolbox as a whole due to their interdependencies. |
14 | 12 |
|
15 | | -* PR-Merge |
16 | | - Validates merges and updates the documentation. |
| 13 | + However, if you know what you are doing and are well-versed in GitHub workflows and actions, you can use just select individual ones or use them as inspiration. Still, an individual approach is likely to be more error-prone. |
17 | 14 |
|
| 15 | +.. note:: |
18 | 16 |
|
19 | | -The toolbox command itself, :code:`tbx`, provides various CLI functions to help you maintain those workflows. |
20 | | -For further help, run the command :code:`tbx workflow --help`. |
| 17 | + The toolbox command itself, :code:`tbx`, provides various CLI functions to help you maintain those workflows. |
| 18 | + For further help, run the command :code:`tbx workflow --help`. |
21 | 19 |
|
22 | | -1. Configure your project |
23 | | -+++++++++++++++++++++++++ |
| 20 | + |
| 21 | +1. Configure the GitHub project |
| 22 | ++++++++++++++++++++++++++++++++ |
24 | 23 |
|
25 | 24 | * Make sure your GitHub project has access to a deployment token for PyPi with the following name: **PYPI_TOKEN**. It should be available to the repository either as an Organization-, Repository-, or Environment-secret. |
26 | 25 |
|
|
0 commit comments