Skip to content

Commit

Permalink
Update doc/user_guide/workflows.rst
Browse files Browse the repository at this point in the history
Co-authored-by: Christoph Kuhnke <[email protected]>
  • Loading branch information
Nicoretti and ckunki authored Sep 27, 2024
1 parent 33439ab commit 0ffccf2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/user_guide/workflows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For further help, run the command :code:`tbx workflow --help`.

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

* If you want to enable manual approval for "slow" CI steps, add an environment named :code:`manual-approval` (:code:`Settings/Environments/manual-approval`) and configure it appropriately.
* If your CI workflow involves slow or expensive steps you can guard these to be executed only after manual approval. The CI workflow will automaticall create a GitHub environment named :code:`manual-approval`. You only need to add reviewers in (:code:`Settings/Environments/manual-approval`) and move the steps to be guarded into the related section in job :code:`slow-checks` in file :code:`.github/workflows/merge-gate.yml`.

2. Add all workflows to your project
++++++++++++++++++++++++++++++++++++
Expand Down

0 comments on commit 0ffccf2

Please sign in to comment.