Page Comparison

This document attempts to cover development and release practices for the synapser projects. As of synapser 1.0.0+, PythonEmbedInR is no longer used.

...

1. Build the R package.  The draft .Rd files are written into a folder called auto-man/

   Code Block
   R CMD INSTALL .

2. Perform a git diff to see what auto-generated files have been added or changed.  The changes should be a small fraction of the overall documents.  Manually transfer the new documents and changes to the man/ folder, editing as needed. For example make sure that any python examples embedded within Python docstrings are properly translated into R equivalent code in the generated documentation.

3. git commit both the auto-generated and manually curated files.

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. 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 where X.Y is the release version (e.g. 0.11)
   Target: the previously created vX.Y-rc branch
   Release title: Same as tag version (X.Y)
   
   Do NOT check the "This is a pre-release" checkbox.
   
   

3. Hit the publish button, this will trigger a GitHub Action that will test and deploy the production release to http://ran.synapse.org/

4. Merge the develop branch to the master branch.

...