The GitHub Action to manually deploy a branch to a sandbox would benefit from confirming with the user who ran the action the branch that they are deploying. Since GitHub Actions does not yet allow input for branch names beyond pure text input, we should add a comment to our workflow informing the user what branch they are deploying: eg. Deploying <branch_name_input> to <chosen environment> as a starting and/or success message.
This ticket also optionally includes researching and/or implementing any improvements you see fit to add to the manual deploy workflow. Some areas for research/improvement include:
Researching how the GitHub Action dashboard page of a action can be modified. Currently the default table on the actions page only shows the branch from which we are deriving the workflow from (a default input in GitHub Actions) which is not as helpful as knowing which dev branch and sandbox we are deploying.
Preliminary research can be done on whether GitHub's built-in Use workflow from field can also be used to denote the branch whose code we're deploying (or if this field only applies the workflow file that is being called as opposed to the entire branch's code). If we can call other parts of the codebase from the branch noted in "Use workflow from" we could possibly combine Use workflow from and the Branch to deploy field into one, with the added benefit that Github sets Use workflow from as a dropdown of all existing branches.
Acceptance criteria
[ ] Add workflow comments before and after deploy indicating what branch and sandbox the GitHub Actions is deploying. Example: Deploying branch <branch_name_input> to <sandbox> // Successfully deployed branch <branch_name_input> to <sandbox>
[ ] Optional: Research and/or implement additional improvements to manual workflow (initial thoughts referenced in issue description)
Issue description
The GitHub Action to manually deploy a branch to a sandbox would benefit from confirming with the user who ran the action the branch that they are deploying. Since GitHub Actions does not yet allow input for branch names beyond pure text input, we should add a comment to our workflow informing the user what branch they are deploying: eg.
Deploying <branch_name_input> to <chosen environment>
as a starting and/or success message.This ticket also optionally includes researching and/or implementing any improvements you see fit to add to the manual deploy workflow. Some areas for research/improvement include:
Researching how the GitHub Action dashboard page of a action can be modified. Currently the default table on the actions page only shows the branch from which we are deriving the workflow from (a default input in GitHub Actions) which is not as helpful as knowing which dev branch and sandbox we are deploying.
Preliminary research can be done on whether GitHub's built-in
Use workflow from
field can also be used to denote the branch whose code we're deploying (or if this field only applies the workflow file that is being called as opposed to the entire branch's code). If we can call other parts of the codebase from the branch noted in "Use workflow from" we could possibly combineUse workflow from
and theBranch to deploy
field into one, with the added benefit that Github setsUse workflow from
as a dropdown of all existing branches.Acceptance criteria
Deploying branch <branch_name_input> to <sandbox>
//Successfully deployed branch <branch_name_input> to <sandbox>
Additional context
No response
Links to other issues
No response