Skip to content

docs: add release.md#723

Merged
psschwei merged 1 commit intogenerative-computing:mainfrom
psschwei:release-doc
Mar 24, 2026
Merged

docs: add release.md#723
psschwei merged 1 commit intogenerative-computing:mainfrom
psschwei:release-doc

Conversation

@psschwei
Copy link
Copy Markdown
Member

@psschwei psschwei commented Mar 23, 2026 •
edited
Loading

Misc PR

Type of PR

  • Bug Fix
  • New Feature
  • Documentation
  • Other

Description

  • Link to Issue: Fixes

Formally documents release process in repo

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code as added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

@psschwei psschwei requested a review from a team as a code owner March 23, 2026 19:34
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 23, 2026

The PR description has been updated. Please fill out the template for your PR to be reviewed.

@psschwei
Copy link
Copy Markdown
Member Author

psschwei commented Mar 23, 2026

@jakelorocco

@mergify
Copy link
Copy Markdown

mergify bot commented Mar 23, 2026 •
edited
Loading

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

ajbozarth
ajbozarth reviewed Mar 23, 2026
View reviewed changes
RELEASE.md Outdated
Comment on lines +18 to +19
- **MINOR** (`x.y`) – Backwards‑compatible new features
- **MAJOR** (`x`) – Breaking API changes
Copy link
Copy Markdown
Contributor

@ajbozarth ajbozarth Mar 23, 2026

Choose a reason for hiding this comment

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

As we've yet to do a major release this not exactly true, some 0.X minor releases have breaking changes afaik

Copy link
Copy Markdown
Contributor

@jakelorocco jakelorocco Mar 23, 2026

Choose a reason for hiding this comment

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

I wasn't aware but semver actually documents this with this rule and the next: https://semver.org/#spec-item-4

We should probably just include a disclaimer here anyways and explain our general process.

Copy link
Copy Markdown
Member Author

@psschwei psschwei Mar 23, 2026

Choose a reason for hiding this comment

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

I went with the simpler "link to semver and note that we note breaking changes" approach 😄

@psschwei
docs: add release.md
12195a3 
Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>
@psschwei psschwei changed the title doc: add release.md docs: add release.md Mar 23, 2026
@psschwei psschwei added this pull request to the merge queue Mar 24, 2026
Merged via the queue into generative-computing:main with commit 16dd0af Mar 24, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ajbozarth ajbozarth ajbozarth left review comments

@jakelorocco jakelorocco jakelorocco approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@psschwei @ajbozarth @jakelorocco