From fa2e53f8a34a6e19ca39584f11f42eda4f7c998f Mon Sep 17 00:00:00 2001 From: Andy Rae <1127507+AndyRae@users.noreply.github.com> Date: Mon, 20 Jul 2026 14:26:34 +0100 Subject: [PATCH 1/2] Clarify release system --- docs/samples/release.container.md | 4 ++++ docs/workflows/semantic-release.md | 4 +++- release.config.js | 1 - samples/release.config.js | 3 +-- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/samples/release.container.md b/docs/samples/release.container.md index d452e51..f09c3fb 100644 --- a/docs/samples/release.container.md +++ b/docs/samples/release.container.md @@ -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 diff --git a/docs/workflows/semantic-release.md b/docs/workflows/semantic-release.md index 902dbc3..7cb1a54 100644 --- a/docs/workflows/semantic-release.md +++ b/docs/workflows/semantic-release.md @@ -75,9 +75,11 @@ module.exports = { '@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 diff --git a/release.config.js b/release.config.js index bc48610..a40d3db 100644 --- a/release.config.js +++ b/release.config.js @@ -9,5 +9,4 @@ module.exports = { '@semantic-release/exec', '@semantic-release/github', ], - "initialVersion": "1.0.0" }; diff --git a/samples/release.config.js b/samples/release.config.js index ced2fab..ec9e119 100644 --- a/samples/release.config.js +++ b/samples/release.config.js @@ -9,5 +9,4 @@ module.exports = { '@semantic-release/exec', '@semantic-release/github', ], - "initialVersion": "1.0.0" -}; \ No newline at end of file +}; From 2e0710e5cac9d0f7a2b0c2d4660f597a74adc6db Mon Sep 17 00:00:00 2001 From: Andy Rae <1127507+AndyRae@users.noreply.github.com> Date: Mon, 20 Jul 2026 14:30:27 +0100 Subject: [PATCH 2/2] MAke it valid json --- docs/workflows/semantic-release.md | 2 +- release.config.js | 2 +- samples/release.config.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/workflows/semantic-release.md b/docs/workflows/semantic-release.md index 7cb1a54..3a75ef7 100644 --- a/docs/workflows/semantic-release.md +++ b/docs/workflows/semantic-release.md @@ -74,7 +74,7 @@ module.exports = { '@semantic-release/release-notes-generator', '@semantic-release/exec', '@semantic-release/github', - ], + ] }; ``` If you have not made an existing semantic versioning release (even manually), the workflow will default to release 1.0.0. diff --git a/release.config.js b/release.config.js index a40d3db..ca5e3f6 100644 --- a/release.config.js +++ b/release.config.js @@ -8,5 +8,5 @@ module.exports = { '@semantic-release/release-notes-generator', '@semantic-release/exec', '@semantic-release/github', - ], + ] }; diff --git a/samples/release.config.js b/samples/release.config.js index ec9e119..91dd6ea 100644 --- a/samples/release.config.js +++ b/samples/release.config.js @@ -8,5 +8,5 @@ module.exports = { '@semantic-release/release-notes-generator', '@semantic-release/exec', '@semantic-release/github', - ], + ] };