Skip to content

Commit

Permalink
Update docs and version strings for version 1.2.1 (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
rly authored Nov 4, 2020
1 parent 54f19b9 commit 1ea4053
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 18 deletions.
9 changes: 2 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ Prepare for release of hdmf-common-schema [version]
- [ ] Update the version string in `docs/source/conf.py` and `common/namespace.yaml` (remove "-alpha" suffix)
- [ ] Update `docs/source/conf.py` as needed
- [ ] Update release notes (set release date) in `docs/source/format_release_notes.rst` and any other docs as needed
- [ ] Test docs locally (`make fulldoc`). Note: if the schema has been changed, then the local copy of HDMF must contain
the latest changes in hdmf-common-schema in the git submodule in order for the schema changes to be reflected in the
docs.
- [ ] Test docs locally (`cd docs; make fulldoc`).
- [ ] Push changes to this PR and make sure all PRs to be included in this release have been merged
- [ ] Point the HDMF submodule to this branch in the HDMF branch corresponding to this schema version and run HDMF tests
- [ ] Check that the readthedocs build for this PR succeeds (build latest to pull the new branch, then activate and
Expand All @@ -22,9 +20,6 @@ Prepare for release of hdmf-common-schema [version]
2. On the [GitHub tags page](https://github.com/hdmf-dev/hdmf-common-schema/tags) page, click "Create release" to
create a release from the new tag. Copy and paste the release notes into the release message and update the title
to the version string.
3. Check that the readthedocs "latest" and "stable" builds run and succeed
4. A new version of HDMF should be released that uses the latest schema release and the schema readthedocs should be
rebuilt. Then schema changes will be reflected in the docs. This is due to a dependency between the docs and the
API.
3. Check that the readthedocs "latest" and "stable" builds run and succeed.

See https://hdmf-common-schema.readthedocs.io/en/latest/software_process.html for more details.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ The schema also provides the following base data structures:

- **Data :** An abstract data type for a dataset
- **Container :** An abstract data type for a generic container storing collections of data and metadata
- **SimpleMultiContainer :** A simple container that holds multiple containers
2 changes: 1 addition & 1 deletion common/namespace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ namespaces:
- doc: data types for different types of sparse matrices
source: sparse.yaml
title: Sparse data types
version: 1.2.1-alpha
version: 1.2.1
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ def setup(app):
# built documents.
#
# The short X.Y version.
version = 'v1.2.1-alpha'
version = 'v1.2.1'
# The full version, including alpha/beta/rc tags.
release = version

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf_doc_autogen.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
spec_resolve_type_inc = False

# Default type map to be used. This is the type map where dependent namespaces are stored.
spec_default_type_map = hdmf.common.get_type_map()
spec_default_type_map = hdmf.build.TypeMap(hdmf.spec.NamespaceCatalog())

# Default specification classes for groups datasets and namespaces.
spec_group_spec_cls = hdmf.spec.GroupSpec
Expand Down
2 changes: 1 addition & 1 deletion docs/source/format_release_notes.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
hdmf-common Release Notes
=========================

1.2.1 (Upcoming)
1.2.1 (November 4, 2020)
------------------------

- Update software process documentation for maintainers.
Expand Down
9 changes: 2 additions & 7 deletions docs/source/software_process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,7 @@ Before merging:
4. Update the version string in ``docs/source/conf.py`` and ``common/namespace.yaml`` (remove "-alpha" suffix)
5. Update ``docs/source/conf.py`` as needed
6. Update release notes (set release date) in ``docs/source/format_release_notes.rst`` and any other docs as needed
7. Test docs locally (``make fulldoc``). Note: if the schema has been changed, then the local copy of HDMF must contain
the latest changes in hdmf-common-schema in the git submodule in order for the schema changes to be reflected in the
docs.
7. Test docs locally (``cd docs; make fulldoc``).
8. Push changes to a new PR and make sure all PRs to be included in this release have been merged. Add
``?template=release.md`` to the PR URL to auto-populate the PR with this checklist.
9. Point the HDMF submodule to this branch in the HDMF branch corresponding to this schema version and run HDMF tests
Expand All @@ -78,10 +76,7 @@ After merging:
release notes into the tag message, and run ``git push --tags``.
2. On the `GitHub tags`_ page, click "Create release" to create a release from the new tag. Copy and paste the release
notes into the release message and update the title to the version string.
3. Check that the readthedocs "latest" and "stable" builds run and succeed
4. A new version of HDMF should be released that uses the latest schema release and the schema readthedocs should be
rebuilt. Then schema changes will be reflected in the docs. This is due to a dependency between the docs and the
API.
3. Check that the readthedocs "latest" and "stable" builds run and succeed.

This checklist can also be found in the `GitHub release PR template`_.

Expand Down

0 comments on commit 1ea4053

Please sign in to comment.