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

8.5.5 - repository release #10

Open
15 of 21 tasks
cbarcl01 opened this issue Dec 5, 2024 · 0 comments
Open
15 of 21 tasks

8.5.5 - repository release #10

cbarcl01 opened this issue Dec 5, 2024 · 0 comments
Assignees

Comments

@cbarcl01
Copy link
Contributor

cbarcl01 commented Dec 5, 2024

Versioning

  • x = changes to fields
  • y = changes to values/ontology IDs
  • z = changes definitions/formats/examples/misc

Incrementing up one point for any number of changes.

Repository Release

  • Upload updated "Excel Template".
    • Versioning x.y.z
  • Upload updated "Reference Guides" (XLSX & PDF).
    • Update the Version Tracking tab
    • Make sure "text wrap" is on before export so all contents are legible in the PDF
    • Do not include "Editor Note" column
    • Clean up formatting (if applicable)
    • Versioning x.y.z (same as template)
  • Upload updated "Canadian Metadata Curation SOP" & "International Metadata Curation SOP".
    • Versioning x.y (same as template, minus "z" changes since those don't come up in the protocol")
  • Upload updated "New Term Request SOP".
    • Versioning x.y (independent versioning since changes to the specification/template doesn't impact this protocol)
  • Draft a new release (Example):
    • Release title: MPox Contextual Data specification package 8.5.5
    • Choose a tag: v#.#.# (create a new tag)
    • Include "Contents:" section that lists the files and their individual version information

      Data Collection Template #.#.#
      Field and Term Reference Guides #.#.#
      Curation Standard Operating Procedure (SOP) #.#.#
      DataHarmonizer Download and Operation Instructions (SOP) #.#
      New Term Request Standard Operating Procedure (SOP) #.#

    • Include "Updates:" section with important information like "fixes", new fields, and a table of fields and their associated changes (e.g., picklist updates, ID/label changes, etc.).
    • Include Release Notes - referencing applicable GitHub #issue release notes

      More details can be found under release notes issue #

    • Set as the latest release
    • Publish release
    • Notify curation team
@cbarcl01 cbarcl01 self-assigned this Dec 5, 2024
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

No branches or pull requests

1 participant