Skip to content

CHORE: Add GitHub Actions CI and install/contributing docs - #40

Draft
bmdavis419 wants to merge 1 commit into
mainfrom
muse/tx9-ci-release
Draft

bmdavis419 wants to merge 1 commit into
mainfrom
muse/tx9-ci-release

Conversation

@bmdavis419

@bmdavis419 bmdavis419 commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Made tx9 release-ready for open source: GitHub Actions CI, install/quickstart docs, and contributor docs. No code changes — no bugs were found.

  • Existing Go tests already self-skip without Docker (TX9_TEST_DOCKER_IMAGE opt-in in internal/docker), so no test tagging was needed; the workflow and docs document how to run them locally.
  • Verification (all run locally before opening this PR):
    • make check — passed (syntax, ShellCheck, guest regressions, gofmt, go vet, go test ./...)
    • go vet ./..., go build ./..., gofmt -l . (clean) — passed
    • make tx9 — passed; ./bin/tx9 prints the box overview
    • TX9_TEST_DOCKER_IMAGE=ubuntu:24.04 go test ./internal/docker/ — passed (opt-in Docker integration tests, not run in CI)
    • Workflow YAML parsed and asserted (triggers on push to main + pull_request; gofmt/vet/build/test steps present)
  • Note: .depot/workflows/check.yml remains the release gate (full make check + site checks). The new GitHub Actions workflow is the dependency-free Go gate for contributors without Depot access.

Important files:

.github/workflows/check.yml

  • New GitHub Actions workflow on push to main and pull_request: gofmt check, go vet ./..., go build ./..., go test ./... on ubuntu-latest with Go from go.mod. No Docker or secrets needed.
  • Documents the TX9_TEST_DOCKER_IMAGE opt-in for running Docker integration tests locally.

README.md

  • Added Install (prereqs, release installer, go install, make tx9 from source) and Quickstart (tx9 create → list/enter/doctor/open/delete) sections.
  • Noted the new GitHub Actions workflow alongside the existing Depot CI description.

CONTRIBUTING.md

  • New file covering prerequisites, build, make check/test commands, Docker integration test opt-in, site checks, and a Makefile target table.

Note

Add GitHub Actions CI workflow and install/contributing docs

  • Adds check.yml: on pushes to main and all PRs, it runs gofmt verification, go vet, build, and go test, with pinned action revisions and read-only permissions
  • Adds README.md with install instructions (release installer, go install, source build) and a quickstart for create, list, enter, doctor, open, and delete commands
  • Adds CONTRIBUTING.md covering build/test commands, Docker integration-test opt-in, Makefile targets, and PR expectations
  • Behavioral Change: GitHub Actions now cancels older in-progress runs for the same ref when a new run starts

Macroscope summarized ab55232.

@coderabbitai

coderabbitai Bot commented Oct 13, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant