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..3a75ef7 100644 --- a/docs/workflows/semantic-release.md +++ b/docs/workflows/semantic-release.md @@ -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 diff --git a/release.config.js b/release.config.js index bc48610..ca5e3f6 100644 --- a/release.config.js +++ b/release.config.js @@ -8,6 +8,5 @@ module.exports = { '@semantic-release/release-notes-generator', '@semantic-release/exec', '@semantic-release/github', - ], - "initialVersion": "1.0.0" + ] }; diff --git a/samples/release.config.js b/samples/release.config.js index ced2fab..91dd6ea 100644 --- a/samples/release.config.js +++ b/samples/release.config.js @@ -8,6 +8,5 @@ module.exports = { '@semantic-release/release-notes-generator', '@semantic-release/exec', '@semantic-release/github', - ], - "initialVersion": "1.0.0" -}; \ No newline at end of file + ] +};