Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with release notes #3

Merged
merged 4 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Release
name: release

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test
name: test

on:
push:
Expand Down
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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 <x.y.z> with the version you’re releasing:
```bash
git tag -s <x.y.z> -m "Version <x.y.z>"
```
3. Push the newly created tag to the remote repository:
```bash
git push origin <x.y.z>
```
Loading