Skip to content

Update release docs & remove snapcraft #1174

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update release docs & remove snapcraft #1174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e79b19c
Update release docs & remove snapcraft
pdabelf5 Oct 14, 2025
c4417d0
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 14, 2025
6a38e43
Update release-process.md
pdabelf5 Oct 14, 2025
0f6a6e7
Address lint issues
pdabelf5 Oct 14, 2025
1291f4e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 14, 2025
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
10 changes: 0 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
![GitHub all releases](https://img.shields.io/github/downloads/nginx/nginx-prometheus-exporter/total?logo=github)
![GitHub release (latest by SemVer)](https://img.shields.io/github/downloads/nginx/nginx-prometheus-exporter/latest/total?sort=semver&logo=github)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nginx/nginx-prometheus-exporter?logo=github&sort=semver)](https://github.com/nginx/nginx-prometheus-exporter/releases/latest)
[![nginx-prometheus-exporter](https://snapcraft.io/nginx-prometheus-exporter/badge.svg)](https://snapcraft.io/nginx-prometheus-exporter)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/nginx/nginx-prometheus-exporter?logo=go)
[![Docker Pulls](https://img.shields.io/docker/pulls/nginx/nginx-prometheus-exporter?logo=docker&logoColor=white)](https://hub.docker.com/r/nginx/nginx-prometheus-exporter)
![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/nginx/nginx-prometheus-exporter?logo=docker&logoColor=white&sort=semver)
Expand Down Expand Up @@ -54,7 +53,6 @@ NGINX Prometheus exporter makes it possible to monitor NGINX or NGINX Plus using
- [Docker images](#docker-images)
- [Binaries](#binaries)
- [Homebrew](#homebrew)
- [Snap](#snap)
- [Scoop](#scoop)
- [Nix](#nix)
- [Building the Exporter](#building-the-exporter)
Expand Down Expand Up @@ -475,14 +473,6 @@ and then install the formula with
brew install nginx-prometheus-exporter
```

### Snap

You can install the NGINX Prometheus Exporter from the [Snap Store](https://snapcraft.io/nginx-prometheus-exporter).

```console
snap install nginx-prometheus-exporter
```

### Scoop

You can add the NGINX Scoop bucket with
Expand Down
19 changes: 14 additions & 5 deletions release-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,24 @@ the [Issue Lifecycle](/ISSUE_LIFECYCLE.md) document for information on issue cre
to ensure that everything is in order.
4. Create a PR to update the version in the `Makefile` and [README](README.md) to the new version, and any other necessary
changes.
5. Once the PR is merged, create a new release tag in the format `vX.Y.Z`:
5. Once the PR is merged, run the release workflow called `Release NGINX Prometheus Exporter` with the new version for the
`version` input:

```bash
git tag -a vX.Y.Z -m "Release vX.Y.Z"
git push origin vX.Y.Z
```text
inputs.version: 1.5.1
```

You can optionally use the following inputs:

```text
inputs.dry_run # Run the release but don't push or publish any artifacts.
inputs.goreleaser_args # Any additional `goreleaser` args you want to pass.
inputs.skip_jobs # Comma separated list of jobs to be skipped, useful for reruns.
inputs.branch # Branch to release from (e.g., when re-running a previous release)
```

As a result, the CI/CD pipeline will:

- Build the Docker image and push it to the registries.
- Publish the release to Snapcraft, Homebrew, Scoop, and Nix.
- Publish the release to Homebrew, Scoop, and Nix.
- Create a GitHub release with the autogenerated changelog and artifacts attached.