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

Autils release process #26

Merged
merged 3 commits into from
Nov 27, 2024
Merged

Autils release process #26

merged 3 commits into from
Nov 27, 2024

Conversation

richtja
Copy link
Contributor

@richtja richtja commented Nov 15, 2024

This PR introduces the release workflow for autils. The release workflow can be triggered manually, or it will be triggered by release-bot after successful voting. The release workflow supports a manual trigger for creating minor version releases, which can be used for security updates or critical fixes.

The PR also introduces pre-release workflow which uses test.pypi to run the dry-run of the release to check release process.

Before the first release, we need to configure the test.pypi and pypi instances and create 0.0 tag to make this fully operational.

Test of the release workflow:
https://github.com/richtja/autils/actions/runs/11840187779/job/32993407763

Test of the pre-release workflow:
https://github.com/richtja/autils/actions/runs/11841451279

Test of the release-bot:
https://github.com/richtja/autils/actions/runs/11856687960

@richtja richtja added the enhancement New feature or request label Nov 15, 2024
@richtja richtja self-assigned this Nov 15, 2024
@richtja richtja linked an issue Nov 15, 2024 that may be closed by this pull request
Copy link
Contributor

@clebergnu clebergnu left a comment

Choose a reason for hiding this comment

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

Hi @richtja,

This looks pretty good, but I left are only two comments/questions.

Thanks!

pyproject.toml Outdated Show resolved Hide resolved
.github/workflows/release.yml Outdated Show resolved Hide resolved
@richtja
Copy link
Contributor Author

richtja commented Nov 25, 2024

Hi @clebergnu, thanks for your review. I have addressed your comments, please have a look.

@richtja richtja requested a review from clebergnu November 25, 2024 16:17
Copy link
Contributor

@clebergnu clebergnu left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Copy link
Contributor

@clebergnu clebergnu left a comment

Choose a reason for hiding this comment

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

Actually, I caught an issue.

The "name" of the project (under pyproject.toml, [project]) needs to be lowercase "autils" too. Or else, the build process would generate:

Successfully built autils-0.1.dev47+gfa9c2de.tar.gz and Autils-0.1.dev47+gfa9c2de-py3-none-any.whl

Which I don't think it's intended.

@richtja
Copy link
Contributor Author

richtja commented Nov 27, 2024

Actually, I caught an issue.

The "name" of the project (under pyproject.toml, [project]) needs to be lowercase "autils" too. Or else, the build process would generate:

Successfully built autils-0.1.dev47+gfa9c2de.tar.gz and Autils-0.1.dev47+gfa9c2de-py3-none-any.whl

Which I don't think it's intended.

Right, good catch. I will fix it.

This commit creates pyproject.toml for configuration of packaging tools.
This file contains basic information about Autils for deployment to PyPi
and configuration for Autils build.

The Autils use setuptools as build backend to ensure compatibility with
Avocado. The build version is dynamic and based on git tags, it will
make easier to automate build process during testing with test.pypi.

Reference: #21
Signed-off-by: Jan Richter <[email protected]>
This is an introduction to pre-release and release wokflows.

The pre-release will build the current main branch a upload it into TEST
PyPi repo to test out the current build.

The release workflow will generate new autils major or minor input based
on the release. Then it will do the build and upload it to PyPi.

Reference: #21
Signed-off-by: Jan Richter <[email protected]>
This commit adds automatic release triggering after the release voting
has been successful. It will run the pre-release checks and if they pass
it will do the release itself.

Reference: #21
Signed-off-by: Jan Richter <[email protected]>
Copy link
Contributor

@clebergnu clebergnu left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@clebergnu clebergnu merged commit 50641c1 into avocado-framework:main Nov 27, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done 109
Development

Successfully merging this pull request may close these issues.

Release Bot - release
2 participants