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

Fix: Release workflow #211

Merged
merged 1 commit into from
Oct 9, 2020
Merged

Conversation

LeoTafti
Copy link
Contributor

@LeoTafti LeoTafti commented Oct 7, 2020

Summary

Changes the release workflow substantially.

Instead of triggering automatically on pushes to master and creating a draft release, the new release workflow is triggered manually (from the GitHub "Actions" tab in the repo) and requires to provide a "bump type" argument which must be one of #major, #minor, #patch (if something else is provided, the release is aborted without making any changes). There was no need for a draft release step anymore, so I removed it.

I also removed tests from the release workflow, and instead trigger the merge PR workflow on pushes to master.

To make a release, the new workflow is thus:

  • Open a PR from develop to master.
  • Merge PR (no need to put #major, … in the commit message anymore). This triggers the "darts merge PR workflow" which runs the full test suite. Wait for them to successfully run (should be the case since they should have already run on the develop branch), and then…
  • Go to the "Actions" tab and select the "darts release workflow".
  • Click "Run workflow" and provide the bump type parameter #major, #minor or #patch

Everything else should happen automatically and a new release published.

This has the big advantage over the last workflow to be less error-prone (no more problems with forgetting to put the bump type "hastag" in the commit message, …), and to allow pushing minor changes to master without triggering the release workflow (which is the problem we had when updating the readme).
The previous workflow also had a flaw in the sense that it made a commit to master changing the version number in config files before creating the draft pull request, rendering the "draft" release step useless since master had already been altered.

Copy link
Contributor

@hrzn hrzn left a comment

Choose a reason for hiding this comment

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

Looks neat :)

Copy link
Contributor

@TheMP TheMP left a comment

Choose a reason for hiding this comment

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

Remember to update Quip ;]

@LeoTafti LeoTafti merged commit 8d553c3 into unit8co:develop Oct 9, 2020
@LeoTafti LeoTafti mentioned this pull request Oct 9, 2020
@LeoTafti LeoTafti deleted the fix/release-workflow branch October 27, 2020 12:34
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.

3 participants