Page Comparison

...

1. Fork https://github.com/Sage-Bionetworks/synapser

2. Checkout a new branch to work on a feature / Jira

3. GitHub Actions are configured in the repositories. Every push will build and test your changes in your forked repo (see the GitHub Actions tab of the repo). On your fork of the synapser repo, add each of the following secrets, the values can be obtained from the "Python Client dev stack openssl keys" entry of LastPass. These allow a test configuration to be installed during builds which enables vignette integration tests to run against test services. 

   1. encrypted_d17283647768_iv

   2. encrypted_d17283647768_key

4. Once your change is ready for review, create a Pull Request with 

   1. base fork: https://github.com/Sage-Bionetworks/synapser

   2. base: develop

   3. head fork: <your Github account>/synapser

   4. compare: <your feature branch>

5. Code view and reviewer merges your change

References:

• Commit Best Practices: http://r-pkgs.had.co.nz/git.html#commit-best-practices

• Git Branch: http://r-pkgs.had.co.nz/git.html#git-branch

• Style: tidyverse style guidelines
  

  • Run

    Code Block
    styler::style_file()

...

As discussed above, the CI/CD for synapser is driven through GitHub Actions. The build is contained in the contained build.yml workflows of the respective repositories (synapser).

References:

• R package docs site tools: https://pkgdown.r-lib.org/

• Github Pages instructions: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

...