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

Release workflow improvements #1627

Merged
merged 5 commits into from
Jan 15, 2023
Merged

Release workflow improvements #1627

merged 5 commits into from
Jan 15, 2023

Conversation

theetrain
Copy link
Collaborator

@theetrain theetrain commented Jan 13, 2023

Introducing some semi-automatic release tooling:

  • remove husky
  • add linting to PR pipelines
  • add release guide to contributing.md, and table of contents
  • add yarn release semi-automatic script, leveraging the standard-version package
  • Lint and fix neglected files. I assume their line endings were incorrect

How to test:

  1. Check guide in CONTRIBUTING.md
  2. Run yarn release. This won't create a commit nor tag; those steps are manual. Note the generated changelog, package.json version bump, and documentation version bump

Next steps: once we're comfortable with these tools, we'll set up continuous delivery.

- Add standard-version to automate version bumping, adding tag, and writing changelog
- remove husky
- add lint script
- update CI pipeline to include linting for pull requests
- format yet-linted files
- add Enrico to contributors
@theetrain theetrain changed the title Release automation Release workflow improvements Jan 14, 2023
package.json Show resolved Hide resolved
Copy link
Collaborator

@metonym metonym left a comment

Choose a reason for hiding this comment

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

Thanks for setting this up.

Tested locally and works as expected. This LGTM pending a couple of comments.

@theetrain
Copy link
Collaborator Author

Thank you; all comments were addressed.

@metonym
Copy link
Collaborator

metonym commented Jan 15, 2023

This is great, especially moving the lint to CI since it caused trouble for some users when they tried contributing. Anything to make the contributing flow better and the release flow automated is a big win.

@metonym metonym merged commit 6d2e21f into master Jan 15, 2023
@metonym metonym deleted the feat/release-automation branch January 15, 2023 23:34
@metonym metonym mentioned this pull request Jan 16, 2023
Copy link

@freezernick freezernick left a comment

Choose a reason for hiding this comment

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

Actually standard-version is deprecated and the recommended successor is https://github.com/absolute-version/commit-and-tag-version

The only changes required are to replace every standard-version with commit-and-tag-version ( and update the dependencies )

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.

None yet

3 participants