Skip to content

docs(adr): accept ADR-0016; fix README release section #79

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

Merged
bketelsen merged 1 commit into from
Oct 24, 2026
Merged

docs(adr): accept ADR-0016; fix README release section #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 12 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1044,37 +1044,27 @@ MIT License.

### Creating a Release

See **[RELEASING.md](RELEASING.md)** for detailed instructions on:
See **[RELEASING.md](RELEASING.md)** for the release process, the required
gates, and the authoritative asset contract. A release needs a human to create
and push the tag.

- Preparing and creating releases
- What happens during the automated release workflow
- Deploying the generated repository archive to S3 or web servers
- Troubleshooting common issues
A `v*.*.*` tag runs `.github/workflows/release.yml`, which uses GoReleaser
(`.goreleaser.yml`) to publish three assets:

Quick start:
| Asset | Purpose |
|---|---|
| `repogen-linux-amd64` | Raw Linux amd64 executable |
| `repogen-linux-arm64` | Raw Linux arm64 executable |
| `SHA256SUMS` | SHA-256 digest list for both executables |

```bash
# Run tests
make test

# Create and push a tag
git tag -a v1.0.0 -m "Release version 1.0.0"
git push origin v1.0.0

# GitHub Actions will automatically:
# - Build binaries for 4 platforms
# - Create native packages (deb, apk, bottle)
# - Generate a repository using repogen itself
# - Create release with all artifacts + repository archive
```
The release does not build native packages, Darwin binaries, or a repository
archive.

### CI/CD Workflows

- **Test Workflow** (`.github/workflows/test.yml`): Runs on PRs and pushes to main
- **Release Workflow** (`.github/workflows/release.yml`): Runs on version tags (v*.*.\*)

The release workflow generates a `repogen-repository-VERSION.zip` archive containing a complete repository that you can extract and deploy to S3, GitHub Pages, or any web server.

## Acknowledgments

- Built with [spf13/cobra](https://github.com/spf13/cobra) for CLI
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ Repo-local decisions; org-wide ones go to frostyard/core and are listed in
— accepted 2026-10-24: deletes the former production commands and the code
behind them; `generate` and `publish-to-r2` do not change
- [ADR-0016 — Remove RPM generation](adr/0016-remove-rpm-generation.md)
— proposed 2026-10-24: GO-2026-5932 (`x/crypto/openpgp`, no fix) is reachable
through go-rpmutils and no consumer uses RPM; deletes the `rpm` type, its
generator, flags and fixtures; adds pinned govulncheck to CI
— accepted 2026-10-24: GO-2026-5932 (`x/crypto/openpgp`, no fix) was
reachable through go-rpmutils and no consumer used RPM; deletes the `rpm`
type, its generator, flags and fixtures; adds pinned govulncheck to CI

### Design

Expand Down
2 changes: 1 addition & 1 deletion docs/adr/0016-remove-rpm-generation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 0016 — Remove RPM generation

- **Status:** Proposed
- **Status:** Accepted
- **Date:** 2026-10-24

## Context
Expand Down
Loading