json-schema-org / json-schema-org/JSON-Schema-Test-Suite

Add a post- spec release checklist

Open
#571 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Python
Stars
750
Forks
307
Avg merge
3d 17h
Merged PRs (30d)
24

Description

There are a few tasks that need doing just after a new version of the specification has been released, or just before:

  • Copy the tests/draft-next and output-tests/draft-next directories to new directories that reflect the new version (copy, not move, as we immediately will start using draft-next for the next draft)
  • Change the URIs of tests using $schema in the copied directories to the "official" new URI
  • Update the latest directory symlink to point to the copied directory
  • Update the READMEs for the above
    • README in root directory
    • README in output-tests directory
  • Update the cross-draft tests
  • Consider updating the test suite schemas (test-schema.json and output-test-schema.json)

We can/should consider automating some of the above (perhaps in the bin/jsonschema_suite tool).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the tests/draft-next and output-tests/draft-next directories, the latest symlink, and the root and output-tests READMEs. Review the cross-draft tests and test-schema.json and output-test-schema.json before applying the post-release checklist. Done means the new version directories, official schema URIs, symlink, READMEs, cross-draft tests, and any needed schemas are updated; consider whether bin/jsonschema_suite should automate part of this.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, release, testing, tooling
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.