Commit b768c40 1 parent 9833f74 commit b768c40 Copy full SHA for b768c40
File tree 1 file changed +34
-0
lines changed
1 file changed +34
-0
lines changed Original file line number Diff line number Diff line change @@ -173,3 +173,37 @@ jobs:
173
173
PR_URL : ${{github.event.pull_request.html_url}}
174
174
GITHUB_TOKEN : ${{secrets.GITHUB_TOKEN}}
175
175
` ` `
176
+
177
+ ## Notes for project maintainers:
178
+
179
+ <details><summary>:book: Release guide</summary>
180
+ <p>
181
+
182
+ - Dependabot PR's:
183
+ - We expect Dependabot PRs to be passing CI and have any changes to the ` dist/` folder built for production dependencies
184
+ - Some development dependencies may fail the `dist/` check if they modify the Typescript compilation, these should be updated manually
185
+ - Checkout and update `main` locally, then generate a patch release branch
186
+ ` ` ` bash
187
+ git checkout main
188
+ git pull
189
+ bin/bump-version -p patch
190
+ ` ` `
191
+ - Generate a draft release for your new version
192
+ ` ` ` bash
193
+ gh release create v1.X.X --generate-notes --draft
194
+ > https://github.com/dependabot/fetch-metadata/releases/tag/untagged-XXXXXX
195
+ ` ` `
196
+ - Create a PR linking to the release notes for review
197
+ ` ` ` bash
198
+ gh pr create --title "v1.X.X Release Notes" --body "https://github.com/dependabot/fetch-metadata/releases/tag/untagged-XXXXXX"
199
+ ` ` `
200
+ - Get the PR reviewed, merge it and publish the release
201
+ - Update the `v1` tracking tag to point to the new version
202
+ ` ` ` bash
203
+ git pull
204
+ git checkout v1.x.x # Check out the release tag
205
+ git tag -f v1 # Force update the tracking tag
206
+ git push -f --tags
207
+ ` ` `
208
+ </p>
209
+ </details>
You can’t perform that action at this time.
0 commit comments