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

Add RELEASING.md #493

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add RELEASING.md #493

wants to merge 1 commit into from

Conversation

andregasser
Copy link
Owner

Description

This PR was long overdue on my side and its purpose is to document the process on how we release development snapshots and release versions using GitHub actions. I have tried to document every step of the process as good as possible, so that other contributors can follow it.

Type of Change

  • Documentation

Breaking Changes

None.

How Has This Been Tested?

Releasing snapshot versions has been tested with the last snapshot release. The release process is not verified yet end to end, but the plan is to do this with the release of 2.0.0.

Mandatory Checklist

  • I ran gradle check and there were no errors reported
  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or that my feature works
  • All tests pass locally with my changes
  • I have added KDoc documentation to all public methods

A simple markdown page that describes the release process for
development snapshots and releases.
@andregasser andregasser added the documentation Improvements or additions to documentation or sample code label Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation or sample code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant