Skip to content

Commit

Permalink
Add updating notes
Browse files Browse the repository at this point in the history
  • Loading branch information
itskingori committed Jan 6, 2025
1 parent 9e536d7 commit 3a2da52
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 3a2da52

Please sign in to comment.