Open
Conversation
Expand the README section on what release-pkg actually does, including PackageInfo.g fields, validation checks, archive creation, GitHub release uploads, dry-run artifacts, and the separation from update-gh-pages. Co-authored-by: Codex <codex@openai.com>
stertooy
reviewed
Mar 11, 2026
Comment on lines
+223
to
+225
| If `dry-run: false` (the default), the action creates or updates a GitHub | ||
| release in the same repository, using the extracted tag, and uploads all | ||
| generated archives plus the manual PDFs as release assets. |
Contributor
There was a problem hiding this comment.
Should perhaps also mention package-info.json?
Comment on lines
+227
to
+229
| If `dry-run: true`, the action does not publish a GitHub release. Instead, it | ||
| uploads the generated archives, manual PDFs, and the supplied `body-text` as a | ||
| workflow artifact. |
Contributor
There was a problem hiding this comment.
Again, perhaps mention package-info.json?
Comment on lines
+231
to
+232
| This action does not build package manuals; do that in a separate workflow step, | ||
| for example via [build-pkg-docs][3]. |
Contributor
There was a problem hiding this comment.
Maybe worth specifying it has to happen in a prior workflow step rather than just separate, since this action assumes the documentation is already present.
limakzi
reviewed
Mar 11, 2026
| The copy step uses `cp -r . ...`, so top-level dotfiles and dot-directories are | ||
| copied into the temporary release tree as well. | ||
|
|
||
| After copying, the action removes some release-irrelevant files from the copied |
Member
There was a problem hiding this comment.
Maybe worth linking to code where it happens?
This catalog is not closed, I think.
| This action does not build package manuals; do that in a separate workflow step, | ||
| for example via [build-pkg-docs][3]. | ||
|
|
||
| This action also does not update a package website or `gh-pages` branch. That |
Member
There was a problem hiding this comment.
I would write a sentence or two that this actions is prerequisite to update-gh-pages.
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
3 participants
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.
Expand the README section on what release-pkg actually does,
including PackageInfo.g fields, validation checks, archive
creation, GitHub release uploads, dry-run artifacts, and the
separation from update-gh-pages.
Co-authored-by: Codex codex@openai.com
Resolves #40