Skip to content

Latest commit

 

History

History
22 lines (20 loc) · 1.59 KB

README.md

File metadata and controls

22 lines (20 loc) · 1.59 KB

gitflow-R

This repository contains the GitHub actions to support the Continuous Integration and Continuous Deployment incorporated Branching Strategy (CI-CD-BS) for R package development.

Instruction to use this tool:

  1. Make sure your repository has the following branches:
     main
     dev
     release*
     feature*
     Conda_Package*
     github_page*
  2. Make a .github/workflows directory under your repo.
  3. Copy the gitflow-R-action.yml from the GitHub Actions folder into the .github/workflows directory if you want the automatic CI-CD-BS.
  4. Copy the Manual_Deployment_to_NIDAP.yml from the GitHub Actions folder into the .github/workflows directory if you want the manual deployment tool.
  5. Update the information at ' image_to_use: "" ' line in gitflow-R-action.yml to a GitHub container registry address for your Docker image.
  6. Update the information at ' uses: fnlcr-bids-sdsi/gitflow-R/.github/workflows/parser.yml@ ' to the specific branch if you have any, or replace with your forked repo address.
  7. Make sure you have a stable conda recipe in "Conda_Recipe" folder.
  8. Make sure you have the repository setup to use github_page for GitHub page delpoyment.
  9. Make sure you have a working container ready to run the CI-CD, sure we can make the environment on the fly, but the time it will take is not optimum.
  10. Please reach out to us for the complete SOP as it contains some internal information.
  11. If you want customed support for actions, please contact us.