Skip to content

Commit 274ea70

Browse files
committed
Update GitHub Workflows documentation
1 parent 807d234 commit 274ea70

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

doc/_static/github-workflows.png

60.1 KB
Loading

doc/user_guide/workflows.rst

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,25 @@
1-
Github Workflows
1+
GitHub Workflows
22
================
33

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
66

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.
88

9-
* CI
10-
Verifies PRs and regularly checks the project.
9+
.. attention::
1110

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.
1412

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.
1714

15+
.. note::
1816

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`.
2119

22-
1. Configure your project
23-
+++++++++++++++++++++++++
20+
21+
1. Configure the GitHub project
22+
+++++++++++++++++++++++++++++++
2423

2524
* 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.
2625

0 commit comments

Comments
 (0)