Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release instructions to README #123

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add release instructions to README #123

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82e84e4
Add release instructions to README
rnestler Dec 31, 2024
5ecccdb
Also update CHANGELOG, MIGRATION and the github workflows
rnestler Dec 31, 2024
1179e4d
Also update the api_compatibility value
rnestler Dec 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,19 @@
![Validate formatting](https://github.com/SpaceApi/schema/workflows/Validate%20formatting/badge.svg?event=push)

These are [JSON Schema](https://json-schema.org/) files for the SpaceAPI.

## Releasing a new version

* Make sure the `CHANGELOG.md` is up to date
* Update `MIGRATION.md` with upgrade instructions
* Rename the current `xx-draft.json` to `xx.json` and create `xx+1-draft.json`
* Replace the `"$id"` field accordingly
* Replace the `"description"` field accordingly
* Replace the `"properties"."api_compatibility"."contains"."const"` accordingly
* Update the `.github/workflows` accordingly
* Update the website
* Regenerate the schema docs
* Update the example
* Update the validator
* Update the schema in https://github.com/spaceapi-community/go-spaceapi-validator and release a new version
* Update the go-spaceapi-validator version in https://github.com/SpaceApi/validator/
Loading