Skip to content

Commit

Permalink
fix: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
HashMapsData2Value committed Jun 20, 2024
1 parent ffc4edd commit 0236125
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,9 @@ Github Workflows are used. `./initialize.sh`is called, which attempts to build t

This project follows [Semantic Versioning](https://semver.org) guidelines and uses `semantic-release` to enforce it.

To create a new release, branch off of `main` into a release branch, e.g. `release/next`. `semantic-release` will run, calculate the next version number based off of the commits, create a corresponding tag and produce a release. The release notes will have been populated from the older commits.
To create a new release, merge off of `main` into the release branch, e.g. `release/1.x`. `semantic-release` will run, calculate the next version number based off of the commits, create a corresponding tag and produce a release. The release notes will have been populated from the older commits.

Afterwards, merge the branch back into `main`. `gradle.properties` which contains the version read by androidModule, jvmModule and sharedModule will have also been updated by `semantic-release`, ensuring the repository release version on GitHub is in-sync with the versions for the respective modules. A new commit will have been made by Github Actions bot.

Note that `semantic-release`is called twice, once to only adjust the `gradle.properties`version, and a second time to actually publish the release. In the process of the first run a git tag is briefly created but it is deleted right after. This is a side-effect of using `semantic-release/exec` to run a script with access to the next-release version to update `gradle.properties`.

These settings are specified in `.releaserc`, .`.adjustVersion/.releaserc`and the `build-and-release` Github workflow.
Afterwards, merge the branch back into `main`. `gradle.properties` which contains the version read by androidModule, jvmModule and sharedModule will have also been updated by `semantic-release`, ensuring the repository release version on GitHub is in-sync with the versions for the respective modules.

## How to Use

Expand Down

0 comments on commit 0236125

Please sign in to comment.