ro-crate
ro-crate copied to clipboard
Release RO-Crate 1.2
Requires all other issues in this milestone to be completed or deferred: https://github.com/ResearchObject/ro-crate/milestone/2
Task list pulled from RELEASE_PROCEDURE.md (may need some updates - please comment with changes so we can make sure the docs are also updated):
The below procedure uses the example of where 1.0
initially is the current release, and 1.1-DRAFT
will become 1.1
as the new current release. Some docs/
paths below must be updated to docs/_specification/
- [ ] GitHub housekeeping
- [x] Create new GitHub milestone for following release - move over issues that won't go into this release
- [x] All recent fixed issues and pull requests on spec (not other pages) have correct milestone
- [ ] No outstanding open issues on milestone.
- [x] No outstanding open pull requests -- or rescheduled for later release (e.g. work in progress).
- [ ] Update team list in
docs/pages/community/community.md
with new members in https://github.com/ResearchObject/ro-crate/issues/1 - [x] Ensure contributors of recent PRs are in RO-Crate team
- [ ] Update changelog - note the use of Semantic Versioning - RO-Crate 1.1 will have GitHub tag
1.1.0
- [ ] If this is a later patch update (e.g. typo in
context.jsonld
) then tag as1.1.1
while all1.1
strings stays the same. No need for new DOI etc, just add to changelog as new patch version.
- [ ] If this is a later patch update (e.g. typo in
- [x] Update author-list in
docs/1.1-DRAFT/index.md
based on team list - [ ] Update
docs/1.1-DRAFT/ro-crate-metadata.json
(base Profile Crate) - [ ] Announce Release Candidate to RO-Crate community - "fire in the hole"!
- [ ] Check for typos, Markdown rendering errors, JSON errors
- [ ] Test examples and DRAFT @context in https://json-ld.org/playground/
- [ ] .. ideally wait 1 week, wait for typo fixes etc.
- [ ] Copy
docs/_specification/1.1-DRAFT/
todocs/_specification/1.1/
- [ ] Search-replace
1.1-DRAFT
to1.1
indocs/_specification/1.1/*
- [x] Prepare a new version of the Zenodo record https://zenodo.org/record/3406497
- [x] Important Do not yet click Publish!
- [x] Delete the old uploads
- [x] Update author list for new members.
- [x] Update description if needed
- [x] Update version
- [x] Update (planned) release date
- [x] Under Related identifiers set the Alternative Identifier to the future w3id permalink https://w3id.org/ro/crate/1.1 and the Previous version to the old permalink https://w3id.org/ro/crate/1.0
- [x] Important Copy the pre-allocated DOI from the draft Zenodo entry
- [x] Check/update permalink https://w3id.org/ro/crate/1.1 in
docs/_specification/1.1/*
. Note that it won't work untildocs/_specification/1.1/
folder exists! - [ ] Add DOI and (planned) release date to
docs/_specification/1.1/index.md
anddocs/_specification/1.1/ro-crate-metadata.json
- [x] Note, there are two DOIs at Zenodo:
- Version-independent https://doi.org/10.5281/zenodo.3406497 pointing to latest version
- Version-specific DOI - which you got from the Zenodo draft
- [ ] Render
docs/_specification/1.1/ro-crate-preview.html
using ro-crate from npm- [ ] Make sure output uses the (not-yet released) permalinks https://w3id.org/ro/crate/1.1 and https://w3id.org/ro/crate/1.1/context
- [ ] Push
docs/_specification/1.1
to GitHub and verify GitHub Pages rendering and permalinks. - [ ] Convert
docs/_specification/1.1/index.md
to HTML and PDF usingpandoc
-
make
can generate PDF (but is not yet updated for new pages -- check output is somewhat sensible)
-
- [ ] Tag in GitHub. Semantic Versioning so RO-Crate 1.1 will be tagged
1.1.0
- [ ] Prepare release artifacts by copying from
docs/_specification/1.1
to a temporary folder. Rename to include version in filename and upload artifacts to the release:-
ro-crate-1.1.0.html
-
ro-crate-1.1.0.pdf
-
ro-crate-context-1.1.0.jsonld
-
ro-crate-metadata.jsonld
-
ro-crate-preview.html
-
- [ ] Update Release notes in GitHub
- [ ] Paste in from Changelog section and the permalink/date headers from
docs/1.1/index.md
- [ ] Example https://github.com/ResearchObject/ro-crate/releases/tag/1.0.0
- [ ] Paste in from Changelog section and the permalink/date headers from
- [ ] Upload same artifacts to Zenodo from the GitHub release.
- Under Related identifiers modify Identical to to point to the new GitHub release tag
- Verify and click Publish
- [ ] Change search
scope
to use new version indocs/_config.yml
- [ ] Announce new version to:
- [ ] RO-Crate team
- [ ] public-rosc
- [ ] researchobject.org
- [ ] Websites of related projects/groups
- [ ] Announcement should only include main point from changelog. Include permalink https://w3id.org/ro/crate/1.1 and DOI as well as link to RO-Crate community issue #1
- [ ] Prepare next draft e.g.
1.2-DRAFT
:- [ ] Copy
docs/_specification/1.1-DRAFT/
todocs/1.2-DRAFT/
and search-replace to1.2-DRAFT
- [ ] Delete
docs/_specification/1.1-DRAFT/*
, but copy releaseddocs/_specification/1.1/context.jsonld
back todocs/_specification/1.1-DRAFT/context.jsonld
(avoid breaking existing use)- Note: Versions before 1.2 were released on https://www.researchobject.org/ro-crate/1.1/context.jsonld etc. instead of https://www.researchobject.org/ro-crate/specification/1.1/context.jsonld which are maintained in
docs/_compatibility/
as direct copies -- do similar copy-back here, but do not make a new1.2
or1.3-DRAFT
folder.
- Note: Versions before 1.2 were released on https://www.researchobject.org/ro-crate/1.1/context.jsonld etc. instead of https://www.researchobject.org/ro-crate/specification/1.1/context.jsonld which are maintained in
- [ ] Copy