Skip to content

Commit 11d96f6

Browse files
committed
update readme
1 parent 3fdc184 commit 11d96f6

1 file changed

Lines changed: 0 additions & 44 deletions

File tree

README.md

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -135,50 +135,6 @@ jobs:
135135
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
136136
```
137137

138-
139-
## Tag Release
140-
This workflow uses the semantic-release npm package to generate a new version tag, changelog, and GitHub release for a repo.
141-
142-
#### Inputs
143-
144-
- `dry_run`: Whether to run in dry_run mode (do not create tags) or not
145-
- `tag_format`: Default `v\\${version}`. A template for the version tag.
146-
- `branch_name`: The branch name to base the release on
147-
- `publish_packages`: comma separated list of package folders to publish to an npm registry
148-
- `asdfVersion`: Override the version of asdf to install.
149-
- `main_branch`: The branch to use for publishing. Defaults to main
150-
- `extra_artifact_name`: optional param to include an extra artifact in the release
151-
- `extra_artifact_id`: optional param of the extra artifact id to include in the release
152-
- `extra_artifact_run_id`: optional param of the run id to download the extra artifact id to include in the release
153-
- `extra_artifact_repository`: optional param to indicate which repo the run to download the artifact was from
154-
155-
#### Outputs
156-
157-
- `version_tag`: The version tag created by semantic-release.
158-
- `change_set_version`: A timestamped string that can be used for creating changesets.
159-
- `next_version_tag`: The next version tag that will be created.
160-
161-
#### Example
162-
163-
To use this workflow in your repository, call it from another workflow file:
164-
165-
```yaml
166-
name: Release
167-
168-
on:
169-
workflow_dispatch:
170-
171-
jobs:
172-
tag_release:
173-
uses: NHSDigital/eps-common-workflows/.github/workflows/tag-release.yml@f5c8313a10855d0cc911db6a9cd666494c00045a
174-
with:
175-
tag_format: "v\\${version}-beta"
176-
dry_run: true
177-
asdfVersion: 0.18.0
178-
branch_name: main
179-
publish_packages: ""
180-
```
181-
182138
## Tag Release - Devcontainer Version
183139
This workflow uses the semantic-release npm package to generate a new version tag, changelog, and GitHub release for a repo.
184140
*The devcontainer MUST have Node installed*

0 commit comments

Comments
 (0)