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

Adds RELEASING.md #94

Merged
merged 1 commit into from
Dec 15, 2023
Merged

Adds RELEASING.md #94

merged 1 commit into from
Dec 15, 2023

Conversation

oldergod
Copy link
Collaborator

No description provided.

Comment on lines +36 to +53
4. Tag the release and push to GitHub.

```
git commit -am "Prepare for release $RELEASE_VERSION."
git tag -a $RELEASE_VERSION -m "Version $RELEASE_VERSION"
git push && git push --tags
```

5. Wait for [GitHub Actions][github_actions] to start building the release.

6. Prepare for ongoing development and push to GitHub.

```
sed -i "" \
"s/VERSION_NAME=.*/VERSION_NAME=$NEXT_VERSION/g" \
`find . -name "gradle.properties"`
git commit -am "Prepare next development version."
git push
```

7. CI will release the artifact and publish the documentation.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@kdubb can you confirm if that's correct?
Specially, will it be auto-released on sonatype or does one have to log on sonatype and release the artifacts?

There's some config in the root build.gradle.kts but I don't know for instance what githubRelease does.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

we'll give it a try and see how it goes!

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes this looks correct. Note that the release workflow is keyed to the following regex:

on:
  push:
    tags: [ "[0-9]+.[0-9]+.[0-9]+**" ]

RELEASING.md Outdated Show resolved Hide resolved
dnkoutso
dnkoutso previously approved these changes Dec 14, 2023
Copy link
Collaborator

@dnkoutso dnkoutso left a comment

Choose a reason for hiding this comment

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

LGTM with one comment

@oldergod oldergod force-pushed the bquenaudon.2023-12-14.releasingdoc branch from a9808b7 to b9d6a35 Compare December 14, 2023 15:28
@dnkoutso dnkoutso merged commit 07082ff into main Dec 15, 2023
1 check passed
@dnkoutso dnkoutso deleted the bquenaudon.2023-12-14.releasingdoc branch December 20, 2023 10:34
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.

3 participants