Skip to content

Commit 042f8db

Browse files
authored
Add a deeplink for tagging releases to the Readme (#369)
1 parent fd7c300 commit 042f8db

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

+12-7
Original file line numberDiff line numberDiff line change
@@ -186,30 +186,35 @@ jobs:
186186
<details><summary>:book: Release guide</summary>
187187
<p>
188188
189-
- Dependabot PR's:
190-
- We expect Dependabot PRs to be passing CI and have any changes to the `dist/` folder built for production dependencies
191-
- Some development dependencies may fail the `dist/` check if they modify the Typescript compilation, these should be updated manually via `npm run build`. See the [`dependabot-build`](https://github.com/dependabot/fetch-metadata/blob/main/.github/workflows/dependabot-build.yml) action for details.
192-
- Checkout and update `main`, then use the `bin/bump-version` script to create a release PR
189+
## Dependabot PR's
190+
191+
- We expect Dependabot PRs to be passing CI and have any changes to the `dist/` folder built for production dependencies
192+
- Some development dependencies may fail the `dist/` check if they modify the Typescript compilation, these should be updated manually via `npm run build`. See the [`dependabot-build`](https://github.com/dependabot/fetch-metadata/blob/main/.github/workflows/dependabot-build.yml) action for details.
193+
194+
## Tagging a new release
195+
196+
1. Checkout and update `main`, then use the `bin/bump-version` script to create a release PR
193197
```bash
194198
git checkout main
195199
git pull
196200
bin/bump-version minor # major | minor | patch
197201
```
198-
- Merge the PR after getting it reviewed
199-
- Create a new release tagged as `v1.X.X` format:
202+
2. Merge the PR after getting it reviewed
203+
3. Create a new release tagged as `v1.X.X` format:
200204
- Either via the web UI: https://github.com/dependabot/fetch-metadata/releases/new
201205
- Or via the CLI:
202206
```bash
203207
gh release create v1.X.X --generate-notes --draft
204208
> https://github.com/dependabot/fetch-metadata/releases/tag/untagged-XXXXXX
205209
# Use the generated URL to review/edit the release notes, and then publish it.
206210
```
207-
- Update the `v1` tracking tag to point to the new version
211+
4. Update the `v1` tracking tag to point to the new version
208212
```bash
209213
git fetch --all --tags
210214
git checkout v1.x.x # Check out the release tag
211215
git tag -f v1 # Force update the tracking tag
212216
git push -f --tags
213217
```
218+
214219
</p>
215220
</details>

0 commit comments

Comments
 (0)