Page Comparison

...

The code base for Synapse R client (wrap Python client) can be found at https://github.com/Sage-Bionetworks/synapser and the code base for Synapserutils package can be found at https://github.com/Sage-Bionetworks/synapserutils/tree/master .

Branches

• master: tracking latest release

• develop: tracking latest development work

• release candidate branches: for each release, a new release candidate branch will be created with name set to the version to release (v1.0-rc).

...

Changing The Version of the Underlying R Client

...

in synapserutils

The synapserutils built on top of the synapser package and the synapser version is specified in the DESCRIPTION file in the Remotes section and would be attached to the package when installing it, for example:

Sage-Bionetworks/synapser@2.1.1

Moreover, functions in synapserutils should mirror what are in the synapseutils. Changes need to be made to synapseUtilsWrapper.py and reference documents.

Step 3: Deploy Staging

Once all JIRA tickets for the new release version are RESOLVED, we are ready to deploy staging version for validation process.

1. Create a new release candidate branch from develop with branch name as the version to release (for example v1.0-rc)

2. Update the docs in the release candidate branch:

   1. ensure you have the R pkgdown package installed (on a Mac you may need to brew install harfbuzz, fribidi, and pandoc if you haven't already)

   2. Update the changelog contained in NEWS.md

   3. Update the version in the DESCRIPTION file, as the version is reflected in the generated documentation.

   4. from the repo directory run the following command:

      Code Block
      R -e "pkgdown::build_site()"

   5. Review the changes by inspecting docs/index.html file.

   6. Commit the changes to the docs directory and push to the release candicate branch

3. Create a new staging release

   1. Go to the releases of the appropriate repo https://github.com/Sage-Bionetworks/synapser/releases

   2. Click the "Draft a new release" button and fill the following values:
      
      Tag version: X.Y-rc where X.Y where X.Y is the release version (e.g. 0.11-rc)
      Target: the previously created vX.Y-rc branch
      Release title: Same as tag version (X.Y-rc)
      
      Important: Check the "Set as a pre-release" checkbox. This will cause the release to be deployed to a staging ran.
      

   3. Use the GitHub release “Generate release notes” feature to create release notes. Copy related content from the NEWS.md to the top of the release notes.

   4. Hit the “Publish release“ button, this will trigger a GitHub Action that will test and deploy the staging release to http://staging-ran.synapse.org/

4. Notify validators about the available version. The validation version will be in format <version-to-build>.<build-number> (For example: 1.0.87, for build number 87).

...

Staging RAN Repo: http://staging-ran.synapse.org. For example, synapser

staging-ran

install.packages("synapser", repos=c("http://staging-ran.synapse.org"))

...

git checkout master
git merge vX.Y.Z-rc
git push upstream master

5. Merge the master branch to develop:

...