Skip to content

Commit d3f1ac2

Browse files
committed
Beautify some lines
1 parent 6499f59 commit d3f1ac2

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

docs/repos/awesome-ci/index.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,37 +8,38 @@ If more functionality is needed you can just open a problem in this project and
88

99
If you have any questions, you can find a form on the issue board. First, make sure your question is already in the Questions and Answers section before asking a question. You can find frequently asked questions directly in the "Questions and Answers" section.
1010

11-
### Notice:
11+
!!! info
1212

13-
Every command that you can use is in the sidebar under commands. All options are listed there.
14-
15-
If you need an example for your pipeline you can find it in the sidebar under the tab examples.
13+
Every command that you can use is in the sidebar under commands. All options are listed there.
14+
If you need an example for your pipeline you can find it in the sidebar under the tab examples.
1615

1716
### Supported naming rules and effects on the version
1817

1918
The patching of the version only takes effect if the merged branch begins with the following aliases, for example: `feature/my-awesome-feature`
2019

21-
> The tailing `/` behind the alias is **always** requiered!
20+
!!! note
21+
22+
The tailing `/` behind the alias is **always** requiered!
2223

2324
| SemVer | supported aliases | version example |
2425
| ------ | ----------------------------- | --------------- |
2526
| MAJOR | `major` | 1.2.3 => 2.0.0 |
2627
| MINOR | `feature`, `feat` | 1.2.3 => 1.3.0 |
2728
| PATCH | `fix`, `bugfix`, `dependabot` | 1.2.3 => 1.2.4 |
2829

29-
> see also [override specialties](#override-specialties)
30+
!!! tldr "good to know"
31+
32+
see also [override specialties](#override-specialties)
3033

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-
```
34+
### awesome ci in your git workflow
3735

3836
![awesome-ci release process](images/release-process.drawio.svg "awesome-ci release process")
37+
3938
![awesome-ci workflow](images/aci-workflow.drawio.png "awesome-ci workflow")
4039

41-
> Hint: this tool automatically detects your environment. Supported are **Jenkins**, **GitHub Actions** and ~~GitLab CI~~
40+
!!! info
41+
42+
This tool automatically detects your environment. Supported are **Jenkins**, **GitHub Actions** and ~~GitLab CI~~
4243

4344
### Override specialties
4445

@@ -66,4 +67,6 @@ List of all environmental variables used per CI tool.
6667
| `GITHUB_TOKEN` | Must provided in pipeline as `env.GITHUB_TOKEN` (see examples) | true |
6768
| `GIT_DEFAULT_BRANCH_NAME` | overrides the default branch name (default: `main`) | false |
6869

69-
> To see your Jenkins environment variables go to: `${YOUR_JENKINS_HOST}/env-vars.html`
70+
!!! info
71+
72+
To see your Jenkins environment variables go to: `${YOUR_JENKINS_HOST}/env-vars.html`

0 commit comments

Comments
 (0)