Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor API Deploy to Env GHA to accept a QA branch other than Main #2016

Open
5 tasks
cris-oddball opened this issue Sep 25, 2024 · 1 comment
Open
5 tasks

Comments

@cris-oddball
Copy link

cris-oddball commented Sep 25, 2024

User Story - Business Need

As we do development that changes routes, the regression also needs to be updated to accommodate any breaking changes. However, when we use the Deploy to {env} workflow, the regression automatically runs against the QA repo's Main, which would fail breaking changes. This is an issue because a failed deployment blocks the ability to merge. This can be overridden by Kyle/Evan, but it should not be necessary. We need to be able to run the regression against a different QA branch to have an improved development cycle.

  • Ticket is understood, and QA has been contacted (if the ticket has a QA label).

User Story(ies)

As a VANotify platform developer
I want to regress the code i have in a branch against any changes in a QA branch that tests my new code
So that I can be assured that the code I am writing works e2e before I open my PR.

Additional Info and Resources

Some starting points:

API workflows
dev_deploy.yml

  • Needs a field to run the regression against a QA branch other than Main (main should be the default, you can write in a different branch) the on workflow_dispatch/workflow_call section, similar to the lambdaDeploy section.
  • Needs a with statement in the run-qa-suite: section that includes the QA branch name

run_regression.yml

  • Needs to accept a branch other than Main in the on workflow_dispatch/workflow_call section as an input for the QA branch, with the default being main
  • That branch input needs to be handed in the jobs section so that it is passed into the trigger-regression.js script

trigger-regression.js

  • Needs to access the branch input from branch variable, as it does with environment.
  • Needs to pass the branch input into the ref field in triggerAndWait

QA workflows
regression.yml already allows for a different branch than main, but check to see if this needs to be modified.

Acceptance Criteria

  • When I use 'Deploy API to Env' action, I am able to input a QA branch name that switches the QA branch regresses the new code
  • This action does indeed run a different QA branch
  • The default of running against Main still works
  • This work is added to the sprint review slide deck (key win bullet point and demo slide)

QA Considerations

  • Work with the dev on validation of this feature.

Potential Dependencies

Out of Scope

  • Running the regression in any branch other than Main in the CI/CD Pipeline
@cris-oddball cris-oddball changed the title Refactor API workflows to acept s QA branch other than Main Refactor API Deploy to Env GHA to accept a QA branch other than Main Sep 25, 2024
@kbelikova-oddball
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants