From 3a2da520f6775d77d9dbbe80cca7cb37d7df205e Mon Sep 17 00:00:00 2001 From: King'ori Maina Date: Mon, 6 Jan 2025 19:32:13 +0200 Subject: [PATCH] Add updating notes --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 266ce4c..23060ce 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,29 @@ docker run --name celery-exporter zappi/celery-exporter:latest For more detailed usage documentation [see upstream](https://github.com/danihodovic/celery-exporter). +## Updating + +When updating the image to use a new version, you need to modify the +`.github/workflows/test.yml` file and submit a pull request. Below are detailed +instructions to guide contributors through the process. + +1. Open the `.github/workflows/test.yml` file in your editor and locate the following section: + ```yaml + env: + # Update this to the exact version that you want to test i.e. the packaging + # into a Docker image. + VERSION: 0.x.0 + ``` +2. Update the `VERSION` field to the desired version: + ```yaml + env: + # Update this to the exact version that you want to test i.e. the packaging + # into a Docker image. + 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: