Skip to content

Commit 8df35e1

Browse files
committed
Update user guide for branch protections
1 parent 87a1cc9 commit 8df35e1

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

doc/changes/unreleased.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,8 @@
22

33
## Bugfixes
44

5-
* #489: Fixed .pre-commit-config.yaml to use existing nox tasks
5+
* #489: Fixed .pre-commit-config.yaml to use existing nox tasks
6+
7+
## Documentation
8+
9+
* #488: Updated user guide to make clearer under which conditions branch protections based on GitHub actions can be enacted

doc/user_guide/workflows.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,6 @@ The exasol-toolbox ships with various GitHub workflow templates. To leverage the
4444
++++++++++++++++++++++++++++
4545

4646
The best and most maintainable way to have solid branch protection (:code:`Settings/Branches/main`) is to require the workflow :code:`CI / Allow Merge` to pass successfully.
47+
48+
.. note::
49+
Setting the required status checks to pass before merging is only possible after running a CI build at **least once** on the affected branch.

0 commit comments

Comments
 (0)