Skip to content

Commit 7584562

Browse files
committed
Update workflows documentation
1 parent 2880dba commit 7584562

File tree

4 files changed

+42
-0
lines changed

4 files changed

+42
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. A new scriv changelog fragment.
2+
3+
..
4+
.. Uncomment the header that is right (remove the leading dots).
5+
..
6+
.. 🗑️ Removed
7+
.. ----------
8+
..
9+
.. - A bullet item for the Removed category.
10+
..
11+
.. ✨ Added
12+
.. ---------
13+
..
14+
.. - A bullet item for the Added category.
15+
..
16+
🔧 Changed
17+
-----------
18+
* Updated workflows documentation
19+
..
20+
.. - A bullet item for the Changed category.
21+
..
22+
.. 🚧 Deprecated
23+
.. --------------
24+
..
25+
.. - A bullet item for the Deprecated category.
26+
..
27+
.. 🐞 Fixed
28+
.. ---------
29+
..
30+
.. - A bullet item for the Fixed category.
31+
..
32+
.. 🔐 Security
33+
.. -----------
34+
..
35+
.. - A bullet item for the Security category.
36+
..

doc/_static/ci-cd-workflow.png

82.9 KB
Loading

doc/_static/ci-workflow.png

73.6 KB
Loading

doc/user_guide/workflows.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ It should be available to the repository either as Organization-, Repository- or
5151
CI Workflow
5252
___________
5353

54+
.. figure:: ../_static/ci-workflow.png
55+
:alt: ci-workflow
56+
5457
To enable this workflow, add a file with the name *ci.yml* in your *.github/workflows* folder
5558
and add the following content:
5659

@@ -64,6 +67,9 @@ ______________
6467

6568
Requires PYPI token to be available
6669

70+
.. figure:: ../_static/ci-cd-workflow.png
71+
:alt: ci-cd-workflow
72+
6773
To enable this workflow, add a file with the name *ci-cd.yml* in your *.github/workflows* folder
6874
and add the following content:
6975

0 commit comments

Comments
 (0)