Documentation drop #381
Merged
Documentation drop #381
Conversation
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
Collaborator
svelderrainruiz
commented
Aug 7, 2025
svelderrainruiz
commented
## Summary - document auto-issue-branch composite action in actions table - link to workflow that invokes the action ## Testing - `node --test .github/actions/auto-issue-branch/utils.test.js` ------ https://chatgpt.com/codex/tasks/task_e_6894c0a0bb50832980dba94bc03c14b2
## Summary - document that feature branches must include `issue-<number>` and that linked issues must be In Progress - reference the `issue-status` job in the composite CI workflow for enforcement ## Testing - `pytest` ------ https://chatgpt.com/codex/tasks/task_e_6894c1c5f8648329aafc8ac4daf70b9f
## Summary - revise troubleshooting and FAQ entries about releases - note that composite pipeline only uploads artifacts and releases must be created separately ## Testing - `pytest` ------ https://chatgpt.com/codex/tasks/task_e_6894c30de9088329b22e26e94cdefdc4
## Summary - replace deprecated `github.repository` usage with `github.event.repository.name` - show setting `REPO_OWNER` and `REPO_NAME` env vars before calling build script - note that `github.repository` returns `owner/repo` and isn't suitable for author field ## Testing - `pytest` ------ https://chatgpt.com/codex/tasks/task_e_6894c450972483298c0303b03f047aa3
## Summary - document that feature branches must include `issue-<number>` and linked issues must be **In Progress** - reference `issue-status` job in composite CI workflow for enforcement ## Testing - `pytest` ------ https://chatgpt.com/codex/tasks/task_e_6894c58628108329b399a6a680f9f60a
## Summary - clarify that `-alpha.<N>`, `-beta.<N>` and `-rc.<N>` use the commit count - note that pre-release and build numbers are identical because both derive from commit count ## Testing - `npm test` *(fails: Could not read package.json)* ------ https://chatgpt.com/codex/tasks/task_e_6894c735248c83299f8ae09623a5802b
## Summary - clarify that the workflow snippet is illustrative and point to the build-ppl and build-vi-package jobs in ci-composite - reference step names like build-lvlibp, modify-vipb-display-info, and build-vi-package instead of line numbers ## Testing - `npm test` *(fails: Could not read package.json)* - `python -m pytest` ------ https://chatgpt.com/codex/tasks/task_e_6894c93465688329a2451d7937f8fe48
## Summary - explain that `build-ppl` and `build-vi-package` jobs handle compiled libraries and final package - note that job names should be referenced instead of line numbers to avoid drift ## Testing - `npm test` *(fails: Could not read package.json)* - `pytest` ------ https://chatgpt.com/codex/tasks/task_e_6894cb653cb88329be2b894ccb6c3a7c
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.