Skip to content

feat: add release process to docs#358

Merged
jferrazbr merged 1 commit intorancher:masterfrom
jferrazbr:docs/add_release_process
Jan 28, 2026
Merged

feat: add release process to docs#358
jferrazbr merged 1 commit intorancher:masterfrom
jferrazbr:docs/add_release_process

Conversation

@jferrazbr
Copy link

@jferrazbr jferrazbr commented Jan 28, 2026

Issue:

N/A (no GitHub issue for this PR).

Problem

Today the rancher/machine repo does not explain the release steps in the documentation.

Solution

Add a new section to README.md called "Releasing a New Version" with a small checklist and the main git commands to:

  • make sure master is up to date
  • check the latest tag
  • create a new tag from the latest master
  • push the tag
  • verify the tag exists on the remote

Testing

Not applicable. This PR only updates documentation.

@jferrazbr jferrazbr marked this pull request as ready for review January 28, 2026 18:02
@jferrazbr jferrazbr requested review from a team and jiaqiluo January 28, 2026 18:24
jiaqiluo
jiaqiluo previously approved these changes Jan 28, 2026
@jiaqiluo jiaqiluo requested a review from a team January 28, 2026 18:30
README.md Outdated

- **Create tag (from latest `master`):**

- `git tag vX.Y.Z`

Choose a reason for hiding this comment

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

can we include the expected tag format for reference? (e.g. v0.15.0-rancher<VERSION>)? It's a weird format, and if you don't look at existing tags someone might confuse it with typical semver. At this point I don't think we'll ever get to v0.16.0.

Copy link
Author

Choose a reason for hiding this comment

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

Make sense, I will change the tag format

Copy link
Author

Choose a reason for hiding this comment

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

done 😄

@jferrazbr jferrazbr requested a review from jiaqiluo January 28, 2026 18:47
@jferrazbr jferrazbr merged commit e1778dc into rancher:master Jan 28, 2026
1 check passed
@jferrazbr jferrazbr deleted the docs/add_release_process branch January 28, 2026 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants