ro-crate icon indicating copy to clipboard operation
ro-crate copied to clipboard
verified publisher icon ResearchObject

Release RO-Crate 1.2

Open elichad opened this issue 1 year ago • 10 comments

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
    • [x] No outstanding open issues on milestone.
    • [x] No outstanding open pull requests -- or rescheduled for later release (e.g. work in progress).
    • [x] 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
  • [x] 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 as 1.1.1 while all 1.1 strings stays the same. No need for new DOI etc, just add to changelog as new patch version.
  • [x] Update author-list in docs/1.1-DRAFT/index.md based on team list
  • [x] Update docs/1.1-DRAFT/ro-crate-metadata.json (base Profile Crate)
  • [x] 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.
  • [x] Copy docs/_specification/1.1-DRAFT/ to docs/_specification/1.1/
  • [ ] Search-replace 1.1-DRAFT to 1.1 in docs/_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 until docs/_specification/1.1/ folder exists!
  • [x] Add DOI and (planned) release date to docs/_specification/1.1/index.md and docs/_specification/1.1/ro-crate-metadata.json
  • [x] Note, there are two DOIs at Zenodo:
  • [x] Render docs/_specification/1.1/ro-crate-preview.html using ro-crate from npm
  • [x] Push docs/_specification/1.1 to GitHub and verify GitHub Pages rendering and permalinks.
  • [x] Convert docs/_specification/1.1/index.md to HTML and PDF using pandoc
    • make can generate PDF (but is not yet updated for new pages -- check output is somewhat sensible)
  • [x] 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
  • [x] Update Release notes in GitHub
  • [x] 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 in docs/_config.yml
  • [ ] Announce new version to:
  • [ ] Prepare next draft e.g. 1.2-DRAFT:
    • [ ] Copy docs/_specification/1.1-DRAFT/ to docs/1.2-DRAFT/ and search-replace to 1.2-DRAFT
    • [ ] Delete docs/_specification/1.1-DRAFT/*, but copy released docs/_specification/1.1/context.jsonld back to docs/_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 new 1.2 or 1.3-DRAFT folder.

elichad avatar Sep 09 '24 11:09 elichad

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

elichad avatar Sep 09 '24 11:09 elichad

Remaining issues on milestone:

  • #300
  • #297 (@dgarijo)

stain avatar Sep 11 '24 23:09 stain

Updated procedure here (not in md) to add milestone housekeeping and checking latest issues are also on the milestone.

stain avatar Sep 11 '24 23:09 stain

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.

stain avatar Sep 11 '24 23:09 stain

Reserved DOI for 1.2.0 is 10.5281/zenodo.13751027

stain avatar Sep 11 '24 23:09 stain

#362 should be clarifide before we release.

stain avatar Oct 04 '24 01:10 stain

This is now unblocked.

ianhinder avatar Nov 18 '24 11:11 ianhinder

Blocked on #381 #380 #379

May also merge #384 after resolving its merge conflict.

stain avatar Jan 07 '25 10:01 stain

--> Prepare release candidate for 2025-03-13 for vote

stain avatar Mar 04 '25 14:03 stain

  • Release candidate 1.2.0 RC1: https://github.com/ResearchObject/ro-crate/releases/tag/1.2.0-RC1
  • Steering commitee vote: https://github.com/ResearchObject/governance/issues/14
  • Discussion on RC1: https://github.com/ResearchObject/governance/discussions/13

stain avatar Apr 28 '25 18:04 stain

RO-Crate 1.2 is released! Thank you everyone. Below is suggested announcement:

Research Object Crate specification RO-Crate version 1.2 has been released.

This release (https://w3id.org/ro/crate/1.2) marks the culmination of a large collaborative effort by the RO-Crate community. Key highlights:

RO-Crate 1.2 constitutes a stable long-term release. For a full list of updates, see the changelog.

The release was approved by the recently formed RO-Crate Steering Committee, who follow the Minimal Viable Governance model, with a mission to write, maintain and release versions of the RO-Crate specification and associated website, as well as advocating RO-Crate use.

The RO-Crate community is open for all to contribute or to join a regional drop-in calls for any questions.

About RO-Crate

Research Object Crate (RO-Crate) is a community effort to establish a lightweight approach to packaging research data with their metadata.

The RO-Crate specification defines a method of aggregating and describing data for distribution, re-use, publishing, preservation and archiving. RO-Crates aggregate data into a Dataset, and may describe any resource including files, URI-addressable resources, or use other addressing schemes to locate digital or physical data.

Describing resources includes technical metadata such as file sizes and types as well as contextual information including how and where datasets and files were created, how they were collated and collected, who was involved in the process, what equipment and software was used, who funded the work, how to cite it, and crucially, how it may be reused, and by whom.

The core of RO-Crate is a machine-readable linked-data document in JSON-LD format known as an RO-Crate Metadata Document. RO-Crate metadata documents can, to a large extent, be created and processed just like any other JSON: knowledge of JSON-LD is not needed, unless extending RO-Crate with additional concepts or combining RO-Crate with other Linked Data technologies.

Citations

Community

Thanks to the RO-Crate community!

Peter Sefton, Eoghan Ó Carragáin, Stian Soiland-Reyes, Oscar Corcho, Daniel Garijo, Raul Palma, Frederik Coppens, Carole Goble, José María Fernández, Kyle Chard, Jose Manuel Gomez-Perez, Michael R Crusoe, Ignacio Eguinoa, Nick Juty, Kristi Holmes, Jason A. Clark, Salvador Capella-Gutierrez, Alasdair J. G. Gray, Stuart Owen, Alan R Williams, Giacomo Tartari, Finn Bacall, Thomas Thelen, Hervé Ménager, Laura Rodríguez Navas, Paul Walk, brandon whitehead, Mark Wilkinson, Paul Groth, Erich Bremer, LJ Garcia Castro, Karl Sebby, Alexander Kanitz, Ana Trisovic, Gavin Kennedy, Mark Graves, Jasper Koehorst, Simone Leo, Marc Portier, Paul Brack, Milan Ojsteršek, Bert Droesbeke, Chenxu Niu, Kosuke Tanabe, Tomasz Miksa, Marco La Rosa, Cedric Decruw, Andreas Czerniak, Jeremy Jay, Sergio Serra, Ronald Siebes, Shaun de Witt, Shady El Damaty, Douglas Lowe, Xuanqi Li, Sveinung Gundersen, Muhammad Radifar, Rudolf Wittner, Oliver Woolland, Paul De Geest, Douglas Fils, Florian Wetzels, Raül Sirvent, Abigail Miller, Jake Emerson, Davide Fucci, Bruno P. Kinoshita, Maciek Bąk, Jens Hollunder, Martin Weise, Vartika Bisht, Toshiyuki Nishiyama Hiraki, Bram Ulrichts, Michael Falk, Eli Chadwick, Daniel Bauer, James Love, Eleni Adamidi, Josh Moore, Lars Schöbitz, Andreas Meier, Juan Fuentes, Edan Bainglass, Balazs E. Pataki, Joe Heffer, Pascal Su, Andrea Davanzo, Meznah Aloqalaa, Pierre-Marie Allard.

The RO-Crate community hosts regular community calls and drop-in sessions, and provide support on Slack. The community is open for anyone to join!
https://www.researchobject.org/ro-crate/community

stain avatar Jun 04 '25 13:06 stain