Skip to content

Commit 6499f59

Browse files
committed
add awesome-ci to docs
1 parent df5da1a commit 6499f59

File tree

4 files changed

+16
-5
lines changed

4 files changed

+16
-5
lines changed

docs/repos/awesome-ci/commands/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ You can find out more about the subcommands by clicking on the relevant one in t
3131

3232
Now available: Any string or any markdown file can now be attached in the release section. In addition, the release assets are attached as text to each release body with the associated sha256. More about that in the picture below and in the release section.
3333

34-
![Release Body with Asstes](../pictures/release-assets-readme.png "Release Body with Asstes")
34+
![Release Body with Asstes](../images/release-assets-readme.png "Release Body with Asstes")

docs/repos/awesome-ci/commands/release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,6 @@ eg.: `-assets "file=path/to/file,file=path/to/second/file"`
4545

4646
Send a custom release description. the input can be either a string or a path to a file.
4747

48-
![Release Body with Asstes](../pictures/release-assets-readme.png "Release Body with Asstes")
48+
![Release Body with Asstes](../images/release-assets-readme.png "Release Body with Asstes")
4949

5050
... more documentation to be done ;)

docs/repos/awesome-ci/index.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,15 @@ The patching of the version only takes effect if the merged branch begins with t
2828

2929
> see also [override specialties](#override-specialties)
3030
31-
![awesome-ci release process](release-process.drawio.svg "awesome-ci release process")
32-
![awesome-ci workflow](aci-workflow.drawio.png "awesome-ci workflow")
31+
```mermaid
32+
graph LR
33+
A(default branch) -- create branch --> B(push to GitHub)
34+
B -- opens PullRequest --> C(open PR)
35+
C --> D{review}
36+
```
37+
38+
![awesome-ci release process](images/release-process.drawio.svg "awesome-ci release process")
39+
![awesome-ci workflow](images/aci-workflow.drawio.png "awesome-ci workflow")
3340

3441
> Hint: this tool automatically detects your environment. Supported are **Jenkins**, **GitHub Actions** and ~~GitLab CI~~
3542

mkdocs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,11 @@ markdown_extensions:
114114
- pymdownx.snippets:
115115
# Fails the build if any imports are missing
116116
check_paths: true
117-
- pymdownx.superfences
117+
- pymdownx.superfences:
118+
custom_fences:
119+
- name: mermaid
120+
class: mermaid
121+
format: !!python/name:pymdownx.superfences.fence_code_format
118122
- pymdownx.tabbed:
119123
alternate_style: true
120124
- pymdownx.tasklist:

0 commit comments

Comments
 (0)