Skip to content

docs: Clarify release system #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AndyRae merged 2 commits into from
Jul 20, 2026
Merged

docs: Clarify release system #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa2e53f
Clarify release system
AndyRae Jul 20, 2026
2e0710e
MAke it valid json
AndyRae Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/samples/release.container.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ uses: health-informatics-uon/workflows/.github/workflows/semantic-release.yml@v1

Check the [releases](https://github.com/health-informatics-uon/workflows/releases) for available versions.

If you have not made an existing semantic versioning release (even manually), the workflow will default to release 1.0.0.

If you would like a pre-1.0.0 release (for example 0.0.1), you should make a release manually through Github, and then the workflow will continue your numbering.

## Languages

### Python
Expand Down
6 changes: 4 additions & 2 deletions docs/workflows/semantic-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,12 @@ module.exports = {
'@semantic-release/release-notes-generator',
'@semantic-release/exec',
'@semantic-release/github',
],
"initialVersion": "0.0.1"
]
};
```
If you have not made an existing semantic versioning release (even manually), the workflow will default to release 1.0.0.

If you would like a pre-1.0.0 release (for example 0.0.1), you should make a release manually through Github, and then the workflow will continue your numbering.

## Python Configuration

Expand Down
3 changes: 1 addition & 2 deletions release.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,5 @@ module.exports = {
'@semantic-release/release-notes-generator',
'@semantic-release/exec',
'@semantic-release/github',
],
"initialVersion": "1.0.0"
]
};
5 changes: 2 additions & 3 deletions samples/release.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,5 @@ module.exports = {
'@semantic-release/release-notes-generator',
'@semantic-release/exec',
'@semantic-release/github',
],
"initialVersion": "1.0.0"
};
]
};