From f49b1f3f44768e37279e7a42e58d85af013d0d27 Mon Sep 17 00:00:00 2001 From: King'ori Maina Date: Mon, 6 Jan 2025 19:11:29 +0200 Subject: [PATCH 1/4] Fix spacing between CI badges --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d47ea28..937cacf 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. From 9ee94841dc7dd459bbda4d71b05d9814c801e9fd Mon Sep 17 00:00:00 2001 From: King'ori Maina Date: Mon, 6 Jan 2025 19:11:37 +0200 Subject: [PATCH 2/4] Add release notes --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 937cacf..266ce4c 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,21 @@ docker run --name celery-exporter zappi/celery-exporter:latest ``` For more detailed usage documentation [see upstream](https://github.com/danihodovic/celery-exporter). + +## 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 + ``` From 9e536d7624f7ee6c398f539c4f5274e5b6898153 Mon Sep 17 00:00:00 2001 From: King'ori Maina Date: Mon, 6 Jan 2025 19:16:43 +0200 Subject: [PATCH 3/4] Prefer lowercase for test names --- .github/workflows/release.yml | 2 +- .github/workflows/test.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) 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: From f43a31cc449ef0f4fe61dd8971d1f2746a8f99d5 Mon Sep 17 00:00:00 2001 From: King'ori Maina Date: Mon, 6 Jan 2025 19:32:13 +0200 Subject: [PATCH 4/4] Add updating notes --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 266ce4c..a9378df 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,25 @@ 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: