Skip to content

Commit 812d419

Browse files
authored
Add release instructions to README (#123)
* Add release instructions to README * Also update CHANGELOG, MIGRATION and the github workflows * Also update the api_compatibility value
1 parent cc27cd4 commit 812d419

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,19 @@
44
![Validate formatting](https://github.com/SpaceApi/schema/workflows/Validate%20formatting/badge.svg?event=push)
55

66
These are [JSON Schema](https://json-schema.org/) files for the SpaceAPI.
7+
8+
## Releasing a new version
9+
10+
* Make sure the `CHANGELOG.md` is up to date
11+
* Update `MIGRATION.md` with upgrade instructions
12+
* Rename the current `xx-draft.json` to `xx.json` and create `xx+1-draft.json`
13+
* Replace the `"$id"` field accordingly
14+
* Replace the `"description"` field accordingly
15+
* Replace the `"properties"."api_compatibility"."contains"."const"` accordingly
16+
* Update the `.github/workflows` accordingly
17+
* Update the website
18+
* Regenerate the schema docs
19+
* Update the example
20+
* Update the validator
21+
* Update the schema in https://github.com/spaceapi-community/go-spaceapi-validator and release a new version
22+
* Update the go-spaceapi-validator version in https://github.com/SpaceApi/validator/

0 commit comments

Comments
 (0)