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

chore[pipeline]: unify QA GitHub actions in one workflow #683

Merged
merged 11 commits into from
Sep 11, 2024

Conversation

davidgamez
Copy link
Member

@davidgamez davidgamez commented Aug 15, 2024

Summary:

As done for PROD environment, QA releases must be driven by a unique GitHub action. This has couple of advantages over multiple triggers:

  • Remove the risk of race conditions between deployments(DB updates, API deployment, etc. ) by establishing an execution order.
  • Easy to spot errors in a single GH action.

Additional changes

  • upgraded terraform setup actions to its latest version(v3)
  • upgraded python setup actions to its latest version(v5)

Working GitHub action example: https://github.com/MobilityData/mobility-feed-api/actions/runs/10783827753

Expected behavior:

Only one deployment GitHub action is triggered by main push event.

Testing tips:

Manual testing will be done against QA environment running the unified workflow.

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Run the unit tests with ./scripts/api-tests.sh to make sure you didn't break anything
  • Add or update any needed documentation to the repo
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)

Copy link

Preview Firebase Hosting URL: https://mobility-feeds-dev--pr-683-4nxu8zda.web.app

Copy link

github-actions bot commented Sep 9, 2024

Preview Firebase Hosting URL: https://mobility-feeds-dev--pr-683-tg4takkg.web.app

Comment on lines -27 to -35
integration-tests:
uses: ./.github/workflows/integration-tests.yml
needs:
- api-build-deployment
with:
API_URL: 'https://api-qa.mobilitydatabase.org'
secrets:
REFRESH_TOKEN: ${{ secrets.QA_API_TEST_REFRESH_TOKEN }}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the integration test here as the caller workflow will be executing integration tests after API deployment.

@davidgamez davidgamez marked this pull request as ready for review September 10, 2024 13:22
@davidgamez davidgamez requested a review from jcpitre September 10, 2024 20:04
Copy link
Contributor

@jcpitre jcpitre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@davidgamez davidgamez merged commit d716d34 into main Sep 11, 2024
6 checks passed
@davidgamez davidgamez deleted the chore/unify-qa-gh-actions branch September 11, 2024 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants