Open elichad opened 1 month ago
Do not interpret this as an announcement that we're releasing 1.2 imminently - this issue is to help prepare for when we do the release in the coming weeks/months
Remaining issues on milestone:
Updated procedure here (not in md
) to add milestone housekeeping and checking latest issues are also on the milestone.
I think for the 1.2 context and profile crate, we don't need to make docs/_compatibility/1.2
copies, as https://github.com/perma-id/w3id.org/blob/master/ro/crate/.htaccess already has been fixed to redirect to the specification/
subdirectory.
Reserved DOI for 1.2.0 is 10.5281/zenodo.13751027
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, and1.1-DRAFT
will become1.1
as the new current release. Somedocs/
paths below must be updated todocs/_specification/
docs/pages/community/community.md
with new members in https://github.com/ResearchObject/ro-crate/issues/11.1.0
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.docs/1.1-DRAFT/index.md
based on team listdocs/1.1-DRAFT/ro-crate-metadata.json
(base Profile Crate)docs/_specification/1.1-DRAFT/
todocs/_specification/1.1/
1.1-DRAFT
to1.1
indocs/_specification/1.1/*
docs/_specification/1.1/*
. Note that it won't work untildocs/_specification/1.1/
folder exists!docs/_specification/1.1/index.md
anddocs/_specification/1.1/ro-crate-metadata.json
docs/_specification/1.1/ro-crate-preview.html
using ro-crate from npmdocs/_specification/1.1
to GitHub and verify GitHub Pages rendering and permalinks.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)1.1.0
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
docs/1.1/index.md
scope
to use new version indocs/_config.yml
1.2-DRAFT
:docs/_specification/1.1-DRAFT/
todocs/1.2-DRAFT/
and search-replace to1.2-DRAFT
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)docs/_compatibility/
as direct copies -- do similar copy-back here, but do not make a new1.2
or1.3-DRAFT
folder.