api icon indicating copy to clipboard operation
api copied to clipboard

Bug: deploying to `beta` is brittle

Open jpmcb opened this issue 10 months ago • 1 comments

Describe the bug

There are some sharp edges when getting changes into the beta environment. The semantic release tool used during pushes to the beta, main, and alpha branches:

https://github.com/open-sauced/api/blob/81d777768704271f91fc879bdf094fd553b4030f/.github/workflows/release.yml#L195-L200

will skip commits that do not have certain key words (like fix, feat, bug, etc.)

For example, during this run, I did not include feat in my commit message, so the release was skipped:

[4:51:36 PM] [semantic-release] [@semantic-release/commit-analyzer] › ℹ  The commit should not trigger a release
[4:51:36 PM] [semantic-release] [@semantic-release/commit-analyzer] › ℹ  Analysis of 2 commits complete: no release

This forced me to do a commit directly to beta to kick off another build which is probably ill advised since we don't want to be shipping commits directly to the main branch on our repos.


We should think about a way to make this process more streamlined and abit less brittle. Maybe a compliance check during PR creation that checks for those keywords?

Steps to reproduce

  1. Push a commit to the beta branch without the keywords in the commit message
  2. See the "Release" actions not create a new beta release.

Browsers

No response

Additional context (Is this in dev or production?)

No response

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

Contributing Docs

  • [X] I agree to follow this project's Contribution Docs

jpmcb avatar Aug 14 '23 17:08 jpmcb