KhronosGroup / KhronosGroup/OpenCL-Docs
Improve Spec Tooling When Building From Tags
- Dominant language
- Python
- Stars
- 420
- Forks
- 131
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
Related to:
> FWIW when a tag is pushed, I wouldn't expect "main" to be the branch, as that has zero information to a user in a PDF. It should either be the tag (which is likely a version) or a commit hash. "main" has very little significance.
_Originally posted by @MathiasMagnus in https://github.com/KhronosGroup/OpenCL-Docs/pull/1351#pullrequestreview-2734828152_
We should improve the spec tooling to better handle the case when building from a tag, which may not have a branch associated with it. This is especially important for automated builds via GitHub actions, which only checks out the tag.
Contributor guide
Research direction
Inspect the spec tooling and automated GitHub Actions build path, then reproduce a build from a checked-out tag rather than a branch. Done means tag builds no longer label the generated PDF as "main" and instead use the tag or a commit hash as described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- build-system, ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100