docs: document 1.0 release sign-off#101
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds maintainer-facing documentation for the 1.0 release sign-off process (manual trusted integration run + tag-triggered publish gating), in both English and Polish release notes, to satisfy the release-documentation acceptance criteria from #94.
Changes:
- Added a “Release sign-off” section to the English 1.0.0 release notes describing the trusted integration run and publish gating.
- Added a “Zatwierdzenie wydania” section to the Polish 1.0.0 release notes with the same procedure.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/en/reference/release-notes-1-0-0.mdx | Documents the 1.0 release sign-off flow (manual integration + publish gating) in English. |
| docs/pl/reference/release-notes-1-0-0.mdx | Documents the 1.0 release sign-off flow (manual integration + publish gating) in Polish. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+93
to
+97
| Stable releases are signed off against one exact trusted commit. Before creating | ||
| a release tag, a maintainer can run the **Integration Tests** workflow manually | ||
| from GitHub Actions and select that commit or branch. The workflow runs only for | ||
| trusted repository events, not pull requests or forks, so KSeF TEST credentials | ||
| are never exposed to untrusted code. |
Comment on lines
+99
to
+102
| Creating an annotated tag such as `v1.0.0` starts **Publish to PyPI** for the | ||
| tagged commit. Its `integration` job runs the credentialed KSeF TEST suite and | ||
| writes the tag, commit SHA, and `TEST` environment to the GitHub Actions job | ||
| summary. Inspect that sign-off before treating the release as successful. |
Comment on lines
+96
to
+100
| Stabilne wydania są zatwierdzane względem jednego, dokładnego commita zaufanego | ||
| repozytorium. Przed utworzeniem tagu wydania maintainer może ręcznie uruchomić | ||
| workflow **Integration Tests** w GitHub Actions i wybrać ten commit albo branch. | ||
| Workflow działa tylko dla zaufanych zdarzeń repozytorium, a nie dla pull requestów | ||
| ani forków, więc dane TEST KSeF nie są udostępniane niezaufanemu kodowi. |
Comment on lines
+102
to
+106
| Utworzenie adnotowanego tagu, na przykład `v1.0.0`, uruchamia **Publish to | ||
| PyPI** dla otagowanego commita. Job `integration` uruchamia uwierzytelniony | ||
| zestaw testów KSeF TEST i zapisuje tag, SHA commita oraz środowisko `TEST` w | ||
| podsumowaniu joba GitHub Actions. Przed uznaniem wydania za udane sprawdź ten | ||
| zapis zatwierdzenia. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the 1.0 release-signoff procedure in English and Polish.
Why
Completes the maintainer-facing release-documentation acceptance criterion from #94.
Closes #94
Validation
python scripts/validate_docs_frontmatter.py docs/git diff --check