Skip to main content

Recommended flows

Basically, we follow https://docs.github.com/en/get-started/quickstart/github-flow.

I have an unapproved add-on and want to check it out​

  • I create an empty repository with an initial commit (just a README.md file)
  • I install the GitHub app
  • In the CMS, I fill in the URL of the repository in the add-on code settings
  • I create a branch (any name) - or create an issue and branch from that
  • I work within the branch, commit to the branch see folder structure for more information on how to structure your code
  • On commit, I create a Pull Request and don't merge
  • Reviewer does a code review
  • Reviewer does a Merge to main branch (master branch) to start the deploy (or manually start the deploy)

I have an approved add-on, but I need to make a change​

  • I create an issue that describes the change I'm going to make from that I create a branch
  • I work within the branch, commit to the branch
  • When I commit for review, I create a Pull Request, but I do NOT merge
  • Reviewer will perform a code review
  • Reviewer does a Merge to the main branch (master branch) to start the deploy (or manually start the deploy)

I have an approved add-on, but I need to hotfix​

  • I commit to the main (master) branch
  • In the commit message I use the prefix Hotfix:
  • The application creates an issue where you can explain what was the reason for the hotfix
  • The application performs a deploy (or you manually run the deploy)