Skip to content

release: add release process doc - #16935

Merged
maykathm merged 7 commits into
canonical:masterfrom
maykathm:maykathm/SNAPDENG-36553-create-release-doc
May 4, 2026
Merged

release: add release process doc#16935
maykathm merged 7 commits into
canonical:masterfrom
maykathm:maykathm/SNAPDENG-36553-create-release-doc

Conversation

@maykathm

Copy link
Copy Markdown
Contributor

No description provided.

@maykathm
maykathm requested review from ernestl and ndyer April 20, 2026 08:23
@maykathm maykathm added Documentation Skip spread Indicate that spread job should not run labels Apr 20, 2026
@maykathm
maykathm requested a review from bboozzoo April 20, 2026 08:24
@codecov

codecov Bot commented Apr 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.04%. Comparing base (b5866da) to head (0917a86).
⚠️ Report is 68 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #16935      +/-   ##
==========================================
+ Coverage   78.94%   79.04%   +0.09%     
==========================================
  Files        1371     1375       +4     
  Lines      190088   190999     +911     
  Branches     2446     2465      +19     
==========================================
+ Hits       150067   150966     +899     
- Misses      30908    30926      +18     
+ Partials     9113     9107       -6     
Flag Coverage Δ
unittests 79.04% <ø> (+0.09%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

github-actions Bot commented Apr 20, 2026

Copy link
Copy Markdown

Mon May 4 09:19:18 UTC 2026

Spread tests skipped

Comment thread RELEASE.md Outdated

Release notes: <link to NEWS.md file from PR>

Please refer to snapd release notes documentation to understand how this is put together: https://docs.google.com/document/d/1do2TFwRIAzuOjLmteVuD0CRoJNO5vVcdUIwTHo4bYO4/edit?tab=t.0#heading=h.ablpjof536fg

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

hm we really put a link to a non-public document in a public SRU bug report?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good point. @ernestl is this something we can change?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we need to make all the bits we need public

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Indeed. There shouldn't be anything about the way we generate release notes that needs to be kept internal, although I recognise the increase in scope here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've added what I think are the important bits from that documentation to this release doc. I then changed the template to point back to this doc. Let me know if this makes sense.

Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md
Comment thread RELEASE.md

@ernestl ernestl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

First pass, probably good idea to have a sync chat.

Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
- If you are generating changelogs for a version that supersedes the major version, remove `New upstream releases, LP#<lp-number>` from the previous version. The `+<ubuntu release>` and the release name from the previous version should match those of the current minor version.
4. Commit NEWS.md and the changelog updates as `release: <version>` into your personal branch
5. Open the PR against `release/<version>`
- The PR description should be formatted as follows (only include the cherry picked section if you have cherry-picked commits):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should we perhaps create a PR template in github and refer to it?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I looked into creating a PR template. It looks to me like managing multiple templates is not amazing and might confuse people. I've left it as is. Feel free to push back if you think we should go ahead with it.

Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
@maykathm
maykathm requested review from bboozzoo and ernestl April 27, 2026 14:49
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
style w4 fill:#222,stroke:#333

subgraph t0 [" "]
T0L["<b>Prepare release content - 6 weeks</b>"]:::label

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would prefer that the release process initiates at the point where we approve the content, rather than 6 weeks earlier.

i.e. "PR 1/2/N testing" doesn't in fact happen under the responsibility of the release engineer.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Changed. @ernestl I changed it to being 1 day to cut the release and create the PR. Sound good?

Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated

@bboozzoo bboozzoo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM. I gather that the original document did not receive as much scrutiny. Please see the comments from @ndyer, but otherwise I think we should land and execute the next release following the document closely. I'm expecting this will be enough to identify remaining issues or inconsistencies.

Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
@maykathm
maykathm requested a review from ndyer April 28, 2026 08:14
Comment thread RELEASE.md Outdated
…unchpad

Co-authored-by: Maciej Borzecki <maciek.borzecki@gmail.com>
Comment thread RELEASE.md Outdated

@ernestl ernestl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is really great, thanks Katie. I left a few comments for your consideration.

Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
Comment thread RELEASE.md
@maykathm
maykathm merged commit 7c9ce9a into canonical:master May 4, 2026
107 of 108 checks passed
@maykathm
maykathm deleted the maykathm/SNAPDENG-36553-create-release-doc branch May 4, 2026 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Skip spread Indicate that spread job should not run

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants