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

Automatic Releases #567

Merged
merged 3 commits into from
Mar 4, 2024
Merged

Automatic Releases #567

merged 3 commits into from
Mar 4, 2024

Conversation

JP-Ellis
Copy link
Contributor

📝 Summary

Automate the release process 🤖

While uploading wheels to PyPI was already automated, this PR further automates:

  • The creation of the changelog
  • The creation of the GitHub release
  • The updating of the changelog on master

This does require a GitHub Personal Access Token (which I have created and added to the pypi environment).

From now on, the only manual step to create a new release should be pushing a new git tag 🥳

🚨 Breaking Changes

🔥 Motivation

Who doesn't want automation?

🔨 Test Plan

This was tested over in my fork. Specifically:

  • The new run is here
  • The generated release is here
  • The generated changelog update PR is here

The run was slightly modified to ensure it runs faster by targeting only cp312-* and x86_64 platforms, but otherwise should be all good.

🔗 Related issues/PRs

@JP-Ellis JP-Ellis requested a review from YOU54F February 28, 2024 22:31
@JP-Ellis JP-Ellis self-assigned this Feb 28, 2024
@YOU54F
Copy link
Member

YOU54F commented Feb 28, 2024

nice work homie, will take a look in the morning

Copy link
Member

@YOU54F YOU54F left a comment

Choose a reason for hiding this comment

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

Pair reviewed with @JP-Ellis, looks great! 🚀

In anticipation of generating changelogs from conventional commits, this
contains a minor change to the formatting of older log entries, and
rewrites the changelog for the most recent release to make usre of the
new format.

Signed-off-by: JP-Ellis <[email protected]>
This PR significant changes the release process, by mostly automating it
all. The docs on creating releases has been updated and moved into the
`docs/` folder (anticipating that we will use MkDocs eventually).

The check step in the build pipeline has been removed, as it is
redundant given that cibuildwheel already does checks.

Signed-off-by: JP-Ellis <[email protected]>
As the `pact.v3` module is still a work in progress, importing
it raises a warning.

Signed-off-by: JP-Ellis <[email protected]>
@JP-Ellis JP-Ellis merged commit 9c345f0 into master Mar 4, 2024
32 of 38 checks passed
@JP-Ellis JP-Ellis deleted the chore/automatic-release branch March 4, 2024 23:31
JP-Ellis added a commit that referenced this pull request Mar 5, 2024
The cibuildwheel process does a check that the wheels are valid, and
also performs an installation of the wheel and a basic check that the
import is working fine. It seems redundant to be doing a separate check.

This was intended in commit 9604839, but a rebase inadvertently
re-intruced the check.

Ref: 02eab542cc667ac3d19bd6acaf0d7a4a0
Ref: #567
Signed-off-by: JP-Ellis <[email protected]>
JP-Ellis added a commit that referenced this pull request Mar 5, 2024
The cibuildwheel process does a check that the wheels are valid, and
also performs an installation of the wheel and a basic check that the
import is working fine. It seems redundant to be doing a separate check.

This was intended in commit 9604839, but a rebase inadvertently
re-intruced the check.

Ref: 02eab542cc667ac3d19bd6acaf0d7a4a0
Ref: #567
Signed-off-by: JP-Ellis <[email protected]>
JP-Ellis added a commit that referenced this pull request Mar 5, 2024
For some reason, the rebase done as part of #567 really did not go well,
and some entire steps were inadvertently replaced. It is my bad, and
here's another (and hopefully final) fix.

Ref: #567
Signed-off-by: JP-Ellis <[email protected]>
JP-Ellis added a commit that referenced this pull request Mar 5, 2024
For some reason, the rebase done as part of #567 really did not go well,
and some entire steps were inadvertently replaced. It is my bad, and
here's another (and hopefully final) fix.

Ref: #567
Signed-off-by: JP-Ellis <[email protected]>
JP-Ellis added a commit that referenced this pull request Mar 5, 2024
For some reason, the rebase done as part of #567 really did not go well,
and some entire steps were inadvertently replaced. It is my bad, and
here's another (and hopefully final) fix.

Ref: #567
Signed-off-by: JP-Ellis <[email protected]>
@JP-Ellis JP-Ellis mentioned this pull request May 1, 2024
1 task
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.

Automate Releases
2 participants