Skip to content

[docs] Add rpm packaging docs#5374

Merged
JuanLeon2 merged 2 commits into
masterfrom
maru/refactor-packaging-docs
May 22, 2026
Merged

[docs] Add rpm packaging docs#5374
JuanLeon2 merged 2 commits into
masterfrom
maru/refactor-packaging-docs

Conversation

@maru-ava
Copy link
Copy Markdown
Contributor

@maru-ava maru-ava commented May 13, 2026

Why this should be merged

Previously the only documentation for rpm packaging was in its stale design doc. In keeping with the new documentation guidelines, this change refactors the design doc into durable documentation that can more effectively inform usage and maintenance.

@maru-ava maru-ava self-assigned this May 13, 2026
@maru-ava maru-ava added documentation Improvements or additions to documentation or examples devinfra labels May 13, 2026
@maru-ava maru-ava moved this to Ready 🚦 in avalanchego May 13, 2026
@maru-ava maru-ava linked an issue May 13, 2026 that may be closed by this pull request
Previously the only documentation for rpm packaging was in its stale design doc. In
keeping with the new documentation guidelines, this change refactors the design doc
into durable documentation that can more effectively inform usage and maintenance.

Change-Id: Ia5d94e0a09f3eda6413dda07c0da89b575d89c5a
@maru-ava maru-ava force-pushed the maru/refactor-packaging-docs branch from 206b615 to a066f7b Compare May 13, 2026 13:57
@maru-ava maru-ava changed the base branch from maru/documentation-guidelines to master May 13, 2026 13:57
@maru-ava maru-ava marked this pull request as ready for review May 13, 2026 13:58
@maru-ava maru-ava requested a review from a team as a code owner May 13, 2026 13:58
Copilot AI review requested due to automatic review settings May 13, 2026 13:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Refactors the RPM packaging documentation by replacing a stale design document with durable, implementation-adjacent documentation under .github/packaging/, intended to better support day-to-day usage and maintenance of the RPM pipeline.

Changes:

  • Removed the outdated docs/design/rpm-packaging.md design doc.
  • Added .github/packaging/README.md documenting the RPM packaging pipeline, entrypoints, CI behavior, signing, validation, and linking rationale.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/design/rpm-packaging.md Removes the old RPM packaging design document.
.github/packaging/README.md Adds durable, packaging-implementation-adjacent documentation for building/signing/validating RPMs and maintaining the pipeline.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/packaging/README.md Outdated
Change-Id: I9cdc19c57f0396eed73e88b8682f8f7cfca2f999
@maru-ava maru-ava requested a review from PlatCore May 19, 2026 15:47
Copy link
Copy Markdown
Contributor

@PlatCore PlatCore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@maru-ava TY for the detailed doc. It provides a broader and deeper perspective on release trade-offs and should be useful for automation.

@JuanLeon2 JuanLeon2 added this pull request to the merge queue May 22, 2026
Merged via the queue into master with commit c31a5d8 May 22, 2026
96 of 98 checks passed
@JuanLeon2 JuanLeon2 deleted the maru/refactor-packaging-docs branch May 22, 2026 16:51
@github-project-automation github-project-automation Bot moved this from Ready 🚦 to Done 🎉 in avalanchego May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devinfra documentation Improvements or additions to documentation or examples

Projects

Status: Done 🎉

Development

Successfully merging this pull request may close these issues.

Ensure completness and discoverability of rpm packaging documentation

4 participants