Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

Add staging release workflow #684

Merged
merged 1 commit into from
Jul 25, 2023
Merged

Add staging release workflow #684

merged 1 commit into from
Jul 25, 2023

Conversation

F-X64
Copy link
Member

@F-X64 F-X64 commented Jul 25, 2023

What has changed?

  • Add checkout for latest release tag on production
  • Add staging workflow

How to run a staging release?

  1. Staging releases will run on push to main.
  2. Staging releases can be triggered manually. Simply head to actions, select the transformer workflow, choose your branch and select the environment you want to run in (staging):
    Screenshot from 2023-07-25 07-44-46
    When running a staging release the latest branch commit will checked out.

Why don't we run the staging release on PRs?
Staging / production releases require AWS credentials. This would only work on PRs opened from branches within the organization but not on PRs opened from forks. There's also the possibility that forks could contain malicious code that we don't want to deploy into our infrastructure.

How to run a production release?

  1. Production releases run on scheduled runs (each night).
  2. Production releases can be triggered from the transformer workflow as mentioned above (just select production as target environment).
    Screenshot from 2023-07-25 07-47-36
    When running production releases, the latest release tag will be checked out.

How to tag a new release?
The easiest way to create a new release tag is to simply create a new release from the release menu in Github.
Make sure to use the next ascending release version and use the schema MAJOR.MINOR.PATCH

To read more about our release process see the documentation

Closes #683

Add checkout for latest release tag on production
Add staging workflow
@F-X64 F-X64 added the github_actions Pull requests that update GitHub Actions code label Jul 25, 2023
@F-X64 F-X64 requested review from major and miyunari July 25, 2023 06:05
@codecov
Copy link

codecov bot commented Jul 25, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (a7a3a75) 93.90% compared to head (20eb285) 93.90%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #684   +/-   ##
=======================================
  Coverage   93.90%   93.90%           
=======================================
  Files           9        9           
  Lines         410      410           
  Branches       88       88           
=======================================
  Hits          385      385           
  Misses         13       13           
  Partials       12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@miyunari miyunari left a comment

Choose a reason for hiding this comment

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

Let's discuss this, I have some questions and suggestions :)

Copy link
Member

@miyunari miyunari left a comment

Choose a reason for hiding this comment

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

I took a closer look and seems legit to me! Thanks for doing this 👍

@F-X64 F-X64 merged commit 9df15ae into main Jul 25, 2023
6 checks passed
@F-X64 F-X64 deleted the add-staging-#683 branch July 25, 2023 11:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add release tagging and staging release
2 participants