Skip to content

Commit

Permalink
Introduce continious releasing (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
StefMa authored Oct 2, 2023
1 parent 306dad7 commit b1044d2
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ on:
push:
tags:
- '*'
branches:
- 'main'

jobs:
publish-kmp-metadata:
Expand Down
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,26 @@ repositories {
dependencies {
implementation("com.ioki:lokalise-api:<latest-version>")
}
```
```

## Release

### Continuous release

By default, each merge to `main` will create a new `SNAPSHOT` release.
If you want to use the latest and greatest use the `SNAPSHOT` version of the library.
But please be aware that they might contain bugs or behaviour changes.

### Proper release

* Checkout `main`
* Pull latest changes
* Adjust version in [`build.gradle.kts`](build.gradle.kts) to a non-SNAPSHOT version
* Commit
* Create a git tag (e.g. `1.0.0`)
* Push to `main` and push the `tag`
* Increase the `version` to the next **minor** version in the `build.gradle.kts` file
* Commit & Push

> **Note**: The `tag` push will create a new release with the [`Publish` workflow](https://github.com/ioki-mobility/kmp-lokalise-api/actions/workflows/publish.yml).

0 comments on commit b1044d2

Please sign in to comment.