Skip to content

Add release workflow and improved documentation#9

Closed
ericlewis wants to merge 1 commit into
codex/document-loader-workflowsfrom
codex/add-release-workflow-docs
Closed

Add release workflow and improved documentation#9
ericlewis wants to merge 1 commit into
codex/document-loader-workflowsfrom
codex/add-release-workflow-docs

Conversation

@ericlewis

Copy link
Copy Markdown
Collaborator

Summary

  • Add a GitHub Actions workflow that builds both loader binaries on PRs, pushes, tags, and manual runs.
  • Package loader artifacts with checksums and support draft GitHub Releases from version tags or manual dispatch.
  • Rewrite the README into a fuller guide covering status, safety, prerequisites, build, release, patching, payload format, troubleshooting, and development notes.

Why

The project did not have an automatic build or release path, and the README did not explain enough for someone new to build, package, or understand the loader safely.

Verification

  • python3 generate_start.py
  • cmake -S . -B /tmp/playbrew-release-docs-build -G Ninja
  • cmake --build /tmp/playbrew-release-docs-build
  • python3 workflow YAML parse check
  • python3 -m py_compile combine.py generate_start.py
  • git diff --check
  • checked README/workflow for the banned bracketed title prefix

@ericlewis ericlewis added documentation Improvements or additions to documentation build Build system and compile changes tooling Developer scripts and workflow tooling release Release packaging and publishing labels May 10, 2026
@ericlewis ericlewis marked this pull request as ready for review May 10, 2026 05:00
@ericlewis ericlewis self-assigned this May 10, 2026
Why: The project did not have an automatic build or release path, and the README did not explain enough for someone new to build, package, or understand the loader safely. This adds a GitHub workflow that builds the loader binaries and can make draft releases, then rewrites the docs with clear setup, build, release, patching, payload, and troubleshooting steps.
@ericlewis ericlewis force-pushed the codex/add-release-workflow-docs branch from 6457930 to 180dfb2 Compare May 10, 2026 05:09
@ericlewis ericlewis changed the base branch from main to codex/document-loader-workflows May 10, 2026 05:10
@ericlewis

Copy link
Copy Markdown
Collaborator Author

Replaced by #18 with the cleaned branch name.

@ericlewis ericlewis closed this May 10, 2026
@ericlewis ericlewis deleted the codex/add-release-workflow-docs branch May 10, 2026 05:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Build system and compile changes documentation Improvements or additions to documentation release Release packaging and publishing tooling Developer scripts and workflow tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant