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.

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

Lint: Sanity check version numbers #1098

Open
michael-wisely-gravwell opened this issue Aug 27, 2024 · 0 comments
Open

Lint: Sanity check version numbers #1098

michael-wisely-gravwell opened this issue Aug 27, 2024 · 0 comments
Labels
02 - Medium medium priority 08 - task other change or action, e.g. refactoring or configuration changes

Comments

@michael-wisely-gravwell
Copy link
Contributor

Task

What needs to be done?

Sanity check version numbers across files

  • The version and url fields in an object in _static/versions.json should match (the version to the path in the URL, that is)
  • Each version listed in _static/versions.json should have a change log
  • Each version listed in _static/versions.json should be listed in changelog/list.md
    • Should be caught by Sphinx - otherwise we'd have a dangling file
  • change log headers should match the filename
  • the release version in conf.py should be present in _static/versions.json and it should be marked preferred and latest

Why is this task needed?

There are a lot of little spots to update when creating a new release. Having some automated sanity checks would help improve confidence.

Any other comments?

Marked medium to match the other Lint issue - I think having an automated check will be helpful during release. We have enough things to think about when we're publishing.

@michael-wisely-gravwell michael-wisely-gravwell added 08 - task other change or action, e.g. refactoring or configuration changes 02 - Medium medium priority labels Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
02 - Medium medium priority 08 - task other change or action, e.g. refactoring or configuration changes
Projects
None yet
Development

No branches or pull requests

1 participant