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

Prepare for release of NWB schema 2.8.0 #597

Draft
wants to merge 6 commits into
base: dev
Choose a base branch
from
Draft

Prepare for release of NWB schema 2.8.0 #597

wants to merge 6 commits into from

Conversation

rly
Copy link
Contributor

@rly rly commented Nov 20, 2024

Prepare for release of nwb-schema 2.8.0
Target release date: November 20, 2024

Before merging:

  • Update requirements versions as needed
  • Update legal file dates and information in Legal.txt, license.txt, README.md, docs/format/source/conf.py,
    and any other locations as needed
  • Update README.rst as needed
  • Update the version string in docs/format/source/conf.py, core/nwb.namespace.yaml, and core/nwb.file.yaml
    (remove "-alpha" suffix)
  • Update docs/format/source/conf.py as needed
  • Update release notes (set release date) in docs/format/source/format_release_notes.rst and any other docs as
    needed
  • Test docs locally (cd docs/format; make fulldoc) and check for warnings and errors
  • Ensure PyNWB and MatNWB have branches that have passing tests when using the head of the dev branch or
    this branch of nwb-schema
  • Push changes to this PR and make sure all PRs to be included in this release have been merged
  • Check that the readthedocs build for this PR succeeds (see auto-triggered PR build):
    https://readthedocs.org/projects/nwb-schema/builds/

After merging:

  1. Create a new git tag. Pull the latest master branch locally, run git tag [version] --sign, copy and paste the
    release notes into the tag message, and run git push --tags.
  2. On the GitHub tags page page,
    click "..." -> "Create release" for the new tag on the right side of the page.
    Copy and paste the release notes into the release message, update the formatting if needed (reST to Markdown),
    and set the title to the version string.
  3. Check that the readthedocs "latest" and "stable" builds run and succeed. Delete the readthedocs build for the
    merged PR. https://readthedocs.org/projects/nwb-schema/builds/
  4. Update the nwb-schema submodule in the PyNWB branch corresponding to this schema version to point to the tagged
    commit.

See https://nwb-schema.readthedocs.io/en/latest/software_process.html for more details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant