diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f2c12a4..3fb6fe5 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,4 +1,4 @@ -name: Release +name: release on: push: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 1d2c021..1df3eda 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,4 +1,4 @@ -name: Test +name: test on: push: diff --git a/README.md b/README.md index d47ea28..a9378df 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # docker-celery-exporter -[![release](https://github.com/Intellection/docker-celery-exporter/actions/workflows/release.yml/badge.svg)](https://github.com/Intellection/docker-celery-exporter/actions/workflows/release.yml) [![test](https://github.com/Intellection/docker-celery-exporter/actions/workflows/test.yml/badge.svg)](https://github.com/Intellection/docker-celery-exporter/actions/workflows/test.yml) +[![release](https://github.com/Intellection/docker-celery-exporter/actions/workflows/release.yml/badge.svg)](https://github.com/Intellection/docker-celery-exporter/actions/workflows/release.yml) +[![test](https://github.com/Intellection/docker-celery-exporter/actions/workflows/test.yml/badge.svg)](https://github.com/Intellection/docker-celery-exporter/actions/workflows/test.yml) Docker image for [`danihodovic/celery-exporter`](https://github.com/danihodovic/celery-exporter), a Prometheus exporter for Celery metrics. @@ -17,3 +18,40 @@ docker run --name celery-exporter zappi/celery-exporter:latest ``` For more detailed usage documentation [see upstream](https://github.com/danihodovic/celery-exporter). + +## Updating + +Below are detailed instructions to guide contributors through the process to update the image to use a new version: + +1. Open the `.github/workflows/test.yml` file in your editor and locate the following section: + ```yaml + env: + VERSION: 0.x.0 + ``` +2. Update the `VERSION` field to the desired version: + ```yaml + env: + VERSION: 0.y.0 + ``` +3. Save the file and commit your changes with a meaningful commit message. +4. Push your branch to GitHub and submit a PR: + * Your pull request will trigger the CI/CD pipeline, which will validate the updated version. + * Ensure the pipeline completes successfully before merging. + +## Releasing + +To cut a new release, follow these steps: + +1. Ensure your local `main` branch is up to date: + ```bash + git checkout main + git fetch origin main + ``` +2. Create a signed tag for the new release replacing with the version you’re releasing: + ```bash + git tag -s -m "Version " + ``` +3. Push the newly created tag to the remote repository: + ```bash + git push origin + ```