-
Notifications
You must be signed in to change notification settings - Fork 187
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
[CI/CD] Fixes #1301: Created automated release workflow #1628
Conversation
4a29ed7
to
22ce682
Compare
Currently, GitHub does not seem to provide an easy way to postpone the execution of one workflow until the other one succeeds. In this PR I have used https://github.com/lewagon/wait-on-check-action to try to integrate a workaround. However, I could not achieve it work properly for every case. In addition, it does not seem to be a too efficient solution as it makes a call to check the status of the other workflow every time the |
I would do the simple thing and just duplicate the lint/test steps in the release. It doesn't matter that it's duplicated. Passing the tests twice is more proof that production isn't going to get code that can't be built. |
Yeah, that makes sense. I will proceed to incorporate that logic into this PR. |
22ce682
to
16f5474
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is good, or at least it seems like it's functioning as expected.
🤤 🤤 🤤 🤤
16f5474
to
06892c4
Compare
Updated the workflow to remove the package version bump action. We should use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you want to add preversion
to our package.json
script to run npm test
? I think that's a logical approach.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
…eneca-CDOT#1628) * ci(improvement): Created release automation workflow Co-authored-by: Andy Yang <yzwdroid@gmail.com>
Issue This PR Addresses
Fixes #1301
Type of Change
Description
Rebased and updated #1527. This PR adds an automated release workflow for GitHub Actions. It would allow us to create a new release by running
npm version
(DON'T RUN THIS CODE UNLESS YOU WANT TO MAKE A PRODUCTION RELEASE):The workflow would also run the same checks as our
node-js-ci
workflow (test, lint, prettier) and generate a changelog to be included in the release.https://github.com/lob/generate-changelog#usage
Example of Generated Changelog:
Example of Workflow Status in GitHub Actions:
How to Test
Create some releases on your forked telescope repository!
issue1301-create-release-workflow
directly by executing the following:You can also create a number of dummy commits in your forked repository before creating a new release to see how the changelog is generated.
We currently use a fairly simple regex to check the pattern of the semantic version. The recommended regex is outlined on semver repository, but it cannot be used in YAML files (some special characters might not be supported in YAML, such as the colon (
:
), for instance).Checklist