Skip to content

Commit

Permalink
πŸ’‡ style: markdownlint
Browse files Browse the repository at this point in the history
  • Loading branch information
Zerohertz committed Oct 31, 2024
1 parent 19fd03d commit 7a7a8ff
Showing 1 changed file with 30 additions and 30 deletions.
60 changes: 30 additions & 30 deletions sphinx/source/cicd.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,27 +62,27 @@ The `chore` branch is utilized when the build result is not different, but there

## Managing Labels for Issues and Pull Requests in GitHub

+ [Issue](https://github.com/Zerohertz/zerohertzLib/blob/master/.github/workflows/issue-controller.yaml)
+ `assignees: ['Zerohertz']`
+ `contains(github.event.issue.title, '[Bug]')` β†’ `labels: ['fix']`
+ `contains(github.event.issue.title, '[Chore]')` β†’ `labels: ['chore']`
+ `contains(github.event.issue.title, '[Style]')` β†’ `labels: ['style']`
+ `contains(github.event.issue.title, '[Docs]')` β†’ `labels: ['docs']`
+ [Pull Request](https://github.com/Zerohertz/zerohertzLib/blob/master/.github/workflows/pr-controller.yaml)
+ `assignees: ['Zerohertz']`
+ `body.includes('bug') || body.includes('fix') || body.includes('μˆ˜μ •')` β†’ `labelsToAdd.push('fix')`
+ `body.includes('style')` β†’ `labelsToAdd.push('style')`
+ `baseBranch === 'master' && headBranch.startsWith('dev')`
+ `labelsToAdd.push('release')`
+ `(file.filename.startsWith('Jenkins') || file.filename.startsWith('.github/workflows'))` β†’ `labelsToAdd.push('chore')`
+ `(file.filename.startsWith('sphinx') && !file.filename.includes('release'))` β†’ `labelsToAdd.push('docs')`
+ `(file.filename.startsWith('zerohertzLib/{MODULE_NAME}/__init__') || body.includes('{MODULE_NAME}'))` β†’ `labelsToAdd.push('feat/{MODULE_NAME}')`
+ `baseBranch === 'master' && headBranch.startsWith('chore')`
+ `labelsToAdd.push('release/chore')`
+ `(file.filename.startsWith('Jenkins') || file.filename.startsWith('.github/workflows'))` β†’ `labelsToAdd.push('chore')`
+ `(file.filename.startsWith('sphinx') && !file.filename.includes('release'))` β†’ `labelsToAdd.push('docs')`
+ `baseBranch.startsWith('dev') || baseBranch.startsWith('chore')) && headBranch === 'docs'`
+ `labelsToAdd.push('docs')`
- [Issue](https://github.com/Zerohertz/zerohertzLib/blob/master/.github/workflows/issue-controller.yaml)
- `assignees: ['Zerohertz']`
- `contains(github.event.issue.title, '[Bug]')` β†’ `labels: ['fix']`
- `contains(github.event.issue.title, '[Chore]')` β†’ `labels: ['chore']`
- `contains(github.event.issue.title, '[Style]')` β†’ `labels: ['style']`
- `contains(github.event.issue.title, '[Docs]')` β†’ `labels: ['docs']`
- [Pull Request](https://github.com/Zerohertz/zerohertzLib/blob/master/.github/workflows/pr-controller.yaml)
- `assignees: ['Zerohertz']`
- `body.includes('bug') || body.includes('fix') || body.includes('μˆ˜μ •')` β†’ `labelsToAdd.push('fix')`
- `body.includes('style')` β†’ `labelsToAdd.push('style')`
- `baseBranch === 'master' && headBranch.startsWith('dev')`
- `labelsToAdd.push('release')`
- `(file.filename.startsWith('Jenkins') || file.filename.startsWith('.github/workflows'))` β†’ `labelsToAdd.push('chore')`
- `(file.filename.startsWith('sphinx') && !file.filename.includes('release'))` β†’ `labelsToAdd.push('docs')`
- `(file.filename.startsWith('zerohertzLib/{MODULE_NAME}/__init__') || body.includes('{MODULE_NAME}'))` β†’ `labelsToAdd.push('feat/{MODULE_NAME}')`
- `baseBranch === 'master' && headBranch.startsWith('chore')`
- `labelsToAdd.push('release/chore')`
- `(file.filename.startsWith('Jenkins') || file.filename.startsWith('.github/workflows'))` β†’ `labelsToAdd.push('chore')`
- `(file.filename.startsWith('sphinx') && !file.filename.includes('release'))` β†’ `labelsToAdd.push('docs')`
- `baseBranch.startsWith('dev') || baseBranch.startsWith('chore')) && headBranch === 'docs'`
- `labelsToAdd.push('docs')`

## Sphinx Documentation Deployment

Expand Down Expand Up @@ -115,15 +115,15 @@ Jenkins (Black, flake8, Pylint, Setuptools, PyTest, Sphinx)

<h2>Jenkins</h2>

|Stage|Condition|
|:-:|-|
|1. `Setup`|β­• [`*` Push]|
|2. `Merge From Docs`|β­• [`*` Push] "Merge pull request\*/docs"</br>β­• [`*` Push] "Merge pull request*[Docs] Build by Sphinx for GitHub Pages"|
|3. `1. Lint`|β­• [`dev*` Push]<br>β­• [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages")|
|4. `2. Build`|β­• [`master` Push] (Except "Merge pull request\*/chore\*")</br>β­• [`dev*` Push]<br>β­• [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages")|
|5. `3. Test`|β­• [`dev*` Push]<br>β­• [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages")|
|6. `4. Docs`|β­• [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages")|
|7. `Deploy`|β­• [`master` Push] "Merge pull request\*from Zerohertz/dev\*" (Except "\*from Zerohertz/chore\*")|
| Stage | Condition |
| :------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1. `Setup` | β­• [`*` Push] |
| 2. `Merge From Docs` | β­• [`*` Push] "Merge pull request\*/docs"</br>β­• [`*` Push] "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages" |
| 3. `1. Lint` | β­• [`dev*` Push]<br>β­• [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages") |
| 4. `2. Build` | β­• [`master` Push] (Except "Merge pull request\*/chore\*")</br>β­• [`dev*` Push]<br>β­• [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages") |
| 5. `3. Test` | β­• [`dev*` Push]<br>β­• [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages") |
| 6. `4. Docs` | β­• [`master` PR] (Except "Merge pull request\*/docs" && "Merge pull request\*[Docs] Build by Sphinx for GitHub Pages") |
| 7. `Deploy` | β­• [`master` Push] "Merge pull request\*from Zerohertz/dev\*" (Except "\*from Zerohertz/chore\*") |

<h3>Dev Branch</h3>

Expand Down

0 comments on commit 7a7a8ff

Please sign in to comment.