2398: Workflow - Manual deploy branch to environment part 1/2

[erinysong]

Ticket

Resolves #2398 - Part 1/2.

Changes

• Adds workflow allowing users to deploy a chosen branch to a chosen sandbox on the GitHub Actions UI.

Context for reviewers

This workflow is meant to merge to main so that the workflow is available to test. Once workflow is verified to work, I will post another PR so that newly created sandboxes are also added to this workflow's environment choices and update docs to add this workflow as a deploy option.

Setup

Code Review Verification Steps

As the original developer, I have

Satisfied acceptance criteria and met development standards

• Met the acceptance criteria, or will meet them in a subsequent PR
• Created/modified automated tests
• Added at least 2 developers as PR reviewers (only 1 will need to approve)
• Messaged on Slack or in standup to notify the team that a PR is ready for review
• Changes to “how we do things” are documented in READMEs and or onboarding guide
• If any model was updated to modify/add/delete columns, makemigrations was ran and the associated migrations file has been commited.

Ensured code standards are met (Original Developer)

• All new functions and methods are commented using plain language
• Did dependency updates in Pipfile also get changed in requirements.txt?
• Interactions with external systems are wrapped in try/except
• Error handling exists for unusual or missing values

Validated user-facing changes (if applicable)

• New pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
• Checked keyboard navigability
• Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
• Add at least 1 designer as PR reviewer

As a code reviewer, I have

Reviewed, tested, and left feedback about the changes

• Pulled this branch locally and tested it
• Reviewed this code and left comments
• Checked that all code is adequately covered by tests
• Made it clear which comments need to be addressed before this work is merged
• If any model was updated to modify/add/delete columns, makemigrations was ran and the associated migrations file has been commited.

Ensured code standards are met (Code reviewer)

• All new functions and methods are commented using plain language
• Interactions with external systems are wrapped in try/except
• Error handling exists for unusual or missing values
• (Rarely needed) Did dependency updates in Pipfile also get changed in requirements.txt?

Validated user-facing changes as a developer

• New pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing

• Checked keyboard navigability

• Meets all designs and user flows provided by design/product

• Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)

• Tested with multiple browsers, the suggestion is to use ones that the developer didn't (check off which ones were used)

  • Chrome
  • Microsoft Edge
  • FireFox
  • Safari

• (Rarely needed) Tested as both an analyst and applicant user

Note: Multiple code reviewers can share the checklists above, a second reviewers should not make a duplicate checklist

As a designer reviewer, I have

Verified that the changes match the design intention

• Checked that the design translated visually
• Checked behavior
• Checked different states (empty, one, some, error)
• Checked for landmarks, page heading structure, and links
• Tried to break the intended flow

Validated user-facing changes as a designer

• Checked keyboard navigability

• Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)

• Tested with multiple browsers (check off which ones were used)

  • Chrome
  • Microsoft Edge
  • FireFox
  • Safari

• (Rarely needed) Tested as both an analyst and applicant user

Screenshots

[github-actions]

🥳 Successfully deployed to developer sandbox es.

[github-actions]

🥳 Successfully deployed to developer sandbox es.

[github-actions]

🥳 Successfully deployed to developer sandbox es.

[github-actions]

🥳 Successfully deployed to developer sandbox es.

[CocoByte]

Recommendation:

It might be easier to test this by forking a branch from main.

Once you have created a forked branch, navigate to your github settings and input values for CF_Username and CF_Password for your sandbox as shown below. (You'll need to have Alysia help you grab those)

[CocoByte]

I went ahead and tested this for you:
https://github.com/CocoByte/manage.get.gov.nl.fork/actions/runs/9964830281/job/27533950015

Looks like there was an issue with comments (could be a config issue in my branch though so I'm going to double-check)

[CocoByte]

Ok, I think the reason the comment didn't work has to do with another secret I am missing in my forked branch. I checked out the deploy action itself and it appears to work great!

Approved -- just double-check the comment portion

[erinysong]

Thank you for testing it locally @CocoByte! Will merge and keep an eye for the workflow you mentioned when testing 🎉