Skip to content

Commit

Permalink
Update release checklist
Browse files Browse the repository at this point in the history
It's just easier without the markdown checkboxes
  • Loading branch information
bhousel committed Jul 17, 2024
1 parent af91e72 commit 9fc70df
Showing 1 changed file with 26 additions and 14 deletions.
40 changes: 26 additions & 14 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,39 @@
## Release Checklist

#### Update version, tag, and publish
- [ ] git checkout main
- [ ] git pull origin
- [ ] npm install
- [ ] npm run test
- [ ] Update version number in `package.json`
- [ ] Update CHANGELOG.md
- [ ] git add . && git commit -m 'vA.B.C'
- [ ] git tag vA.B.C
- [ ] git push origin main vA.B.C
- [ ] npm publish
- [ ] Go to GitHub and link the release notes to the changelog

```bash
# Make sure your main branch is up to date and all tests pass
git checkout main
git pull origin
npm install
npm run all

# Pick a version, see https://semver.org/ - for example: 'A.B.C' or 'A.B.C-pre.D'
# Update version number in `package.json`
# Update CHANGELOG.md

export VERSION=vA.B.C-pre.D
git add . && git commit -m "$VERSION"
git tag "$VERSION"
git push origin main "$VERSION"
npm publish
```

Set as latest release on GitHub:
- Open https://github.com/rapideditor/location-conflation/blob/main/CHANGELOG.md and copy the URL to the new release
- Open https://github.com/rapideditor/location-conflation/tags and pick the new tag you just pushed
- There should be a link like "create a release from the tag", click that, and paste in the link to the changelog.


### Purge JSDelivr CDN cache
Include any URLs that iD/Rapid/others might request.
Include any URLs that anyone might request.

```bash
curl 'https://purge.jsdelivr.net/npm/@rapideditor/location-conflation/dist/location-conflation.iife.js'
curl 'https://purge.jsdelivr.net/npm/@rapideditor/location-conflation/dist/location-conflation.iife.min.js'
curl 'https://purge.jsdelivr.net/npm/@rapideditor/location-conflation@1/dist/location-conflation.iife.js'
curl 'https://purge.jsdelivr.net/npm/@rapideditor/location-conflation@1/dist/location-conflation.iife.min.js'
curl 'https://purge.jsdelivr.net/npm/@rapideditor/location-conflation@1.3/dist/location-conflation.iife.js'
curl 'https://purge.jsdelivr.net/npm/@rapideditor/location-conflation@1.3/dist/location-conflation.iife.min.js'
curl 'https://purge.jsdelivr.net/npm/@rapideditor/location-conflation@1.4/dist/location-conflation.iife.js'
curl 'https://purge.jsdelivr.net/npm/@rapideditor/location-conflation@1.4/dist/location-conflation.iife.min.js'
```

0 comments on commit 9fc70df

Please sign in to comment.