1
- # Release Checklist
1
+ ## Release Checklist
2
2
3
- ### Icons
3
+ ### Update Icons
4
4
This project bundles some icons from FontAwesome, corresponding to the types of
5
5
community resources. Whenever the list of resource types changes:
6
- - [ ] Edit ` build_icons.js `
7
- - [ ] npm run icons
8
6
9
- ### Update main branch, make sure tests pass
10
- - [ ] git checkout main
11
- - [ ] git pull origin
12
- - [ ] npm install
13
- - [ ] npm run test
7
+ ``` bash
8
+ # Edit `scripts/build_icons.js`
9
+ npm run icons
10
+ ```
11
+
12
+
13
+ ### Update changelog, version, tag, and publish
14
14
15
- ### Update translations
16
- - [ ] npm run txpull
17
- - [ ] git add i18n/ && git commit -m 'npm run txpull'
15
+ ``` bash
16
+ # Make sure your main branch is up to date and all tests pass
17
+ git checkout main
18
+ git pull origin
19
+ npm install
20
+ npm run test
21
+
22
+ # Update translations
23
+ npm run txpull
24
+ git add i18n/ && git commit -m ' npm run txpull'
25
+
26
+ # Pick a version, see https://semver.org/ - for example: 'A.B.C' or 'A.B.C-pre.D'
27
+ # Update version number in `package.json`
28
+ # Update CHANGELOG.md and docs as needed
29
+ export VERSION=vA.B.C-pre.D
30
+ npm run dist
31
+ git add . && git commit -m " $VERSION "
32
+ git tag " $VERSION "
33
+ git push origin main " $VERSION "
34
+ npm publish
35
+ ```
18
36
19
- ### Update changelog, version, tag, then publish
20
- - [ ] Update ` CHANGELOG.md `
21
- - [ ] Update version number in ` package.json `
22
- - [ ] npm run dist
23
- - [ ] git add . && git commit -m 'vA.B.C'
24
- - [ ] git tag vA.B.C
25
- - [ ] git push origin main vA.B.C
26
- - [ ] npm publish
37
+ Set as latest release on GitHub:
38
+ - Open https://github.com/osmlab/osm-community-index/blob/main/CHANGELOG.md and copy the URL to the new release
39
+ - Open https://github.com/osmlab/osm-community-index/tags and pick the new tag you just pushed
40
+ - There should be a link like "create a release from the tag", click that, and paste in the link to the changelog.
27
41
28
- Open https://github.com/osmlab/osm-community-index/tags
29
- Click "Add Release Notes" and link to the CHANGELOG
30
42
31
- ### Purge cache (optional)
43
+ ### Purge JSDelivr CDN cache
44
+ Include any URLs that anyone might request.
32
45
33
46
``` bash
34
47
curl ' https://purge.jsdelivr.net/gh/osmlab/osm-community-index@main/dist/completeFeatureCollection.min.json'
@@ -38,7 +51,7 @@ curl 'https://purge.jsdelivr.net/npm/osm-community-index/dist/resources.min.json
38
51
curl ' https://purge.jsdelivr.net/npm/osm-community-index@5/dist/defaults.min.json'
39
52
curl ' https://purge.jsdelivr.net/npm/osm-community-index@5/dist/featureCollection.min.json'
40
53
curl ' https://purge.jsdelivr.net/npm/osm-community-index@5/dist/resources.min.json'
41
- curl ' https://purge.jsdelivr.net/npm/osm-community-index@5.8 /dist/defaults.min.json'
42
- curl ' https://purge.jsdelivr.net/npm/osm-community-index@5.8 /dist/featureCollection.min.json'
43
- curl ' https://purge.jsdelivr.net/npm/osm-community-index@5.8 /dist/resources.min.json'
54
+ curl ' https://purge.jsdelivr.net/npm/osm-community-index@5.9 /dist/defaults.min.json'
55
+ curl ' https://purge.jsdelivr.net/npm/osm-community-index@5.9 /dist/featureCollection.min.json'
56
+ curl ' https://purge.jsdelivr.net/npm/osm-community-index@5.9 /dist/resources.min.json'
44
57
```
0 commit comments