Skip to content

Commit 6d3ab0a

Browse files
committed
chore
1 parent 5f90783 commit 6d3ab0a

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[![Build Status](https://img.shields.io/github/workflow/status/docker-client/docker-compose-v3/Publish?style=for-the-badge)](https://github.com/docker-client/docker-compose-v3/actions)
2+
[![Maven Central](https://img.shields.io/maven-central/v/de.gesellix/docker-compose.svg?style=for-the-badge&maxAge=86400)](https://search.maven.org/search?q=g:de.gesellix%20AND%20a:docker-compose)
3+
14
# docker-compose-v3
25

36
### About
@@ -19,4 +22,8 @@ You can find a real life example at the [Docker Client's DeployConfigReader](htt
1922

2023
### Contributing
2124

22-
Feel free to submit an issue if you'd like to ask a question or propose a new feature (maybe Compose v2 support?). Pull Requests are welcome, too!
25+
Please submit an issue if you'd like to ask a question or propose a new feature (maybe Compose v2 support?). Pull Requests are welcome, too!
26+
27+
## Publishing/Release Workflow
28+
29+
See RELEASE.md

RELEASE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Publishing
2+
3+
Packages are automatically published from the `main` branch to the GitHub Package Registry.
4+
Manually cut releases will be published to both GitHub Package Registry and Maven Central.
5+
6+
## Release Workflow
7+
8+
There are multiple GitHub Action Workflows for the different steps in the package's lifecycle:
9+
10+
- CI: Builds and checks incoming changes on a pull request
11+
- triggered on every push to a non-default branch
12+
- CD: Publishes the Gradle artifacts to GitHub Package Registry
13+
- triggered only on pushes to the default branch
14+
- Release: Publishes Gradle artifacts to Sonatype and releases them to Maven Central
15+
- triggered on a published GitHub release using the underlying tag as artifact version, e.g. via `git tag -m "$MESSAGE" v$(date +"%Y-%m-%dT%H-%M-%S")`

0 commit comments

Comments
 (0)