Skip to content

Home

Jump to bottom
Ken McLeod edited this page Nov 28, 2019 · 12 revisions

Instructions to update profiles

  1. Update the GSheet.

  2. Pull github repo and branch it.

  3. Generate the yaml using GoWeb. This will be your new profile file.

  4. Find the previous version of the profile. I.e., the latest version in the _profiles subdirectory of the GitHub repo. Copy the header from this file (i.e., from the 1st line of the file up to, but not including, the spec_info: line). You can see the header from DataCatalog in the next code snippet.

---
redirect_from:
- "devSpecs/DataCatalog/specification"
- "devSpecs/DataCatalog/specification/"
- "/devSpecs/DataCatalog/"
- "/profiles/DataCatalog/"

name: DataCatalog

previous_version: '0.3-DRAFT-2019_06_20'
previous_release: '0.2-RELEASE-2019_06_14'

status: release #revision replace with revision for next version
spec_type: Profile
group: datarepositories
use_cases_url: /useCases/DataRepository/
cross_walk_url: https://docs.google.com/spreadsheets/d/1kB_0vPm78oPZOE9wJWFvBnlU9PN6j9Jk0FzqoqxImYA/
gh_tasks: https://github.com/BioSchemas/specifications/labels/type%3A%20DataCatalog
live_deploy: /liveDeploys/

parent_type: DataCatalog
hierarchy:
- Thing
- CreativeWork
- DataCatalog


# spec_info content generated using GOWeb
# DO NOT MANUALLY EDIT THE CONTENT
spec_info:

  1. Paste the header into the yaml file you generated with GoWeb in step 3.

  2. Delete the redirects from the previous version of the profile. Save this.

  3. Update the previous_version and previous_release properties in your new profile (i.e. the yaml file generated by GoWeb).

  4. In this header change the status. It should be either release or revision

  5. Make sure the cross_walk_url points to the current gDoc

  6. Add the html from the previous version to the bottom of new yaml file (see below)

---
<!DOCTYPE HTML>
<html>
   {% include head.html %}
   <body>
      {% include header.html %}
      {% include navbar.html %}
      <div class="page-content">
         <div class="wrapper">
            <div id="main-content-wrapper" class="outer">
               <section id="main_content" class="inner">
                  {% include profile_start.html %}
                  {% include specification_table.html %}
               </section>
            </div>
         </div>
      </div>
      {% include footer.html %}
   </body>
</html>

NOTE I think both the devSpec and specifications files have the same html

  1. Rename the file as ProfileName.html, eg, DataCatalog.html or Dataset.html. Both the devSpec and specification versions have the same name. In terms of differences between the specification and devSpec versions the following are possible:
  • Actual yaml properties, cardinality etc
  • cross_walk_url value
  • version value (also date etc)
  • redirect_from values in the header

  1. Copy the specification version to bioschemas.github.io / _specifications and the devSpec version to bioschemas.github.io / _devSpecs

  2. Commit changes, push branch and create pull request

Clone this wiki locally