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 Please #374

Merged
merged 4 commits into from
Sep 2, 2024
Merged

Release Please #374

merged 4 commits into from
Sep 2, 2024

Conversation

mariugul
Copy link
Collaborator

@mariugul mariugul commented Aug 28, 2024

Summary: Introduction of Release-Please

Adds release-please to the project.

This pull request introduces Release-Please to automate release process. Release-Please is a tool that manages releases by generating changelogs, creating GitHub releases, and updating version numbers based on conventional commit messages. It works by analyzing merged PRs and determining the next version number (major, minor, or patch) according to the conventional commit spec. Once the changes are merged, Release-Please creates a release PR, which, when approved and merged, triggers the release workflow, ensuring a consistent and reliable release process without manual intervention.

Note: Only features and bugfixes are released. So if you commit a docs update or a refactor no PR or package is built and released.

Release to PyPi

When release-please successfuly creates a release, poetry builds a new package of pikaraoke and publishes it.

ToDo @vicwomg

  • Create environment pypi. No need to put anything in there, just create it. settings -> Environments -> create.
  •  Create a secrets.RELEASE_PLEASE_TOKEN.
  • Merge and test this.

Keeps track of the python package version.
Adds release please as a tool to automatically create
PR's in GitHub incrementing python package versions,
as well as building and publishing packages to PyPi
on new releases.
@mariugul
Copy link
Collaborator Author

mariugul commented Sep 1, 2024

@vicwomg please review this 😄 It will be really nice to have before merging any new PR's

@vicwomg
Copy link
Owner

vicwomg commented Sep 2, 2024

I was looking yesterday, but got hung up on the secret. Do I need to create an account and generate a Release Please token myself to put into the env secrets? Where would I do that?

@mariugul
Copy link
Collaborator Author

mariugul commented Sep 2, 2024

I was looking yesterday, but got hung up on the secret. Do I need to create an account and generate a Release Please token myself to put into the env secrets? Where would I do that?

It should be just a GitHub secret to authorize release please to generate releases. I will find the steps.

@mariugul
Copy link
Collaborator Author

mariugul commented Sep 2, 2024

I was looking yesterday, but got hung up on the secret. Do I need to create an account and generate a Release Please token myself to put into the env secrets? Where would I do that?

See creating-a-fine-grained-personal-access-token or creating-a-personal-access-token-classic. It should be pretty straight forward. Just name it whatever and give it sufficient permissions to read and write. Remember to copy the token.

After that, go into settings -> Secrets and variables -> Actions in pikaraoke. Add the token you generated in GitHub as a New repository secret. Name this one RELEASE_PLEASE_TOKEN.

@vicwomg vicwomg merged commit 16c22c2 into vicwomg:master Sep 2, 2024
2 checks passed
@vicwomg
Copy link
Owner

vicwomg commented Sep 2, 2024

I created the token and merged, but there's a GHA error on master:

release-please failed: base (vicwomg/pikaraoke): Failed to parse manifest versions JSON: .release-please-manifest.json
Unexpected end of JSON input

lmk if there's more configuration needed on my part

@mariugul
Copy link
Collaborator Author

mariugul commented Sep 2, 2024

I created the token and merged, but there's a GHA error on master:

release-please failed: base (vicwomg/pikaraoke): Failed to parse manifest versions JSON: .release-please-manifest.json
Unexpected end of JSON input

lmk if there's more configuration needed on my part

I think you did it correctly. It looks like to me that it's a stupid thing that it isn't recognized as json. I will open a fix PR.

@mariugul mariugul deleted the ci/release-please branch September 2, 2024 19:09
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.

2 participants