This document describes the suggested workflow to properly update the PCI website. Following this workflow should guarantee easily traceable cause and effect of actions and code safety enforced via automated build tests.
-
DO NOT push to main branch directly.
-
All side branches must be first merged to
developfor staging tests before being merged intomain.
-
User / Developer discovers a bug in the website. A similar case that would trigger the same workflow is a new feature for the website is being requested.
-
A github issue describing the bug discovery or feature request should be created.
-
Developer creates a branch based on this github issue.
The branch name should be something like:
-
Developer completes the feature / fixes the bug, and pushes a commit that resolves the related issue.
-
(Optional but recommended) Build the app locally to check for any build errors
-
Developer creates a pull request, references the related issue in the comment, and merges the branch into
developbranch.
-
Developer checks the latest github action triggered by step 6 to see if it succeeded, if not continue working on the sub-branch and attempt pull request until the github action succeeds.
-
View the latest beta version on beta.policychangeindex.org
Note: The website would only reflected the latest commit in
developif the build pipeline in github action succeeded. -
Important!! Consult confirmation from the website owners before merging into
main, via pull request. -
Create a github release with version tagging.
