Merge pull request #105 from futuredapp/housekeep/this-and-that

Housekeep

.github/workflows/publish_snapshot.yml

@@ -4,6 +4,10 @@ on:
   push:
     branches: [ master ]
 
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: true
+
 jobs:
   build:
     name: Build master branch

.github/workflows/pull_request.yml

@@ -2,8 +2,9 @@ name: Check PR
 on: [pull_request]
 
 concurrency:
-  group: ${{ github.head_ref }}
+  group: ${{ github.workflow }}-${{ github.head_ref }}
   cancel-in-progress: true
+
 jobs:
   pr:
     name: PR check

PUBLISHING.md

@@ -0,0 +1,20 @@
+# Publishing
+
+Each new version should have entry in [CHANGELOG.md](./CHANGELOG.md) document.
+
+## Snapshots
+
+Snapshots are built, signed and published to Maven Central snapshot repo using [CI workflow](.github/workflows/publish_snapshot.yml) with each commit to the `master` branch.
+
+Snapshots versions grouped based on major version of library and the snapshot version can be configured in project-level `gradle.properties` file:
+```properties
+VERSION_NAME=2.X.X-SNAPSHOT
+```
+
+## Releases
+
+Releases are built, signed and published to Maven Central using [CI workflow](.github/workflows/publish_release.yml), after GitHub release is published.
+The `VERSION_NAME` property is set to match the GitHub release name:
+```shell
+./gradlew publish -PVERSION_NAME=${{ github.event.release.name }}
+```

README.md

@@ -3,7 +3,7 @@
 # Donut
 
 [![Download](https://img.shields.io/maven-central/v/app.futured.donut/donut)](https://search.maven.org/search?q=app.futured.donut)
-[![Build Status](https://github.com/futuredapp/donut/workflows/master/badge.svg)](https://github.com/futuredapp/donut/actions)
+[![Publish snapshot](https://github.com/futuredapp/donut/actions/workflows/publish_snapshot.yml/badge.svg)](https://github.com/futuredapp/donut/actions/workflows/publish_snapshot.yml)
 [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Donut-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/8015)
 [![Android Weekly](https://androidweekly.net/issues/issue-449/badge)](https://androidweekly.net/issues/issue-449)
 ![License](https://img.shields.io/github/license/futuredapp/donut?color=black)
@@ -218,8 +218,7 @@ The quickest way to explore different styles is to try the [sample](sample/) app
 
 ## Contributors
 
-Current maintainer and main contributor for the original version is [Matej Semančík](https://github.com/matejsemancik) and for Jetpack Compose version is [Martin Sumera](https://github.com/sumeramartin)
-
+Current maintainer and main contributor for the original version is [Matej Semančík](https://github.com/matejsemancik) and for Jetpack Compose version is [Martin Sumera](https://github.com/sumeramartin). Check the [PUBLISHING.md](PUBLISHING.md) document for releasing and publishing guidelines.
 
 ## Licence