Skip to content

Document GitHub App authentication for Workspaces#471

Merged
gjkim42 merged 1 commit intomainfrom
kelos-task-436
Feb 28, 2026
Merged

Document GitHub App authentication for Workspaces#471
gjkim42 merged 1 commit intomainfrom
kelos-task-436

Conversation

@kelos-bot
Copy link

@kelos-bot kelos-bot bot commented Feb 27, 2026

Summary

  • Document the fully implemented but undocumented GitHub App authentication option for Workspaces across all user-facing docs
  • Add a new "Workspace Authentication" section to docs/reference.md explaining PAT vs GitHub App secrets, including secret key descriptions and kubectl create examples
  • Add githubApp config fields (appID, installationID, privateKeyPath) to the CLI configuration reference and kelos init template
  • Add GitHub App mention to README credentials section, example workspace YAML, and self-development README

Closes #436

Test plan

  • make verify passes
  • Review rendered markdown for correctness and formatting
  • Verify all internal doc links resolve (e.g., #workspace-authentication)

🤖 Generated with Claude Code


Summary by cubic

Documents GitHub App authentication for Workspaces and updates examples to make org/prod setups clearer. Addresses task 436 by clarifying PAT vs App usage and exposing githubApp config in the CLI template.

  • New Features
    • Added Workspace Authentication docs: PAT vs GitHub App, secret keys, and kubectl examples.
    • Updated config reference and kelos init template with githubApp fields (appID, installationID, privateKeyPath); token and githubApp are mutually exclusive.
    • Updated README, example workspace YAML, and self-development docs to show GitHub App setup and recommend it for org use.

Written for commit 0572e18. Summary will update on new commits.

GitHub App authentication is fully implemented but was absent from all
user-facing documentation. Add GitHub App auth docs to:

- docs/reference.md: Workspace Authentication section with PAT vs GitHub
  App comparison, secret key descriptions, and kubectl create examples
- docs/reference.md: Configuration section with githubApp config fields
- README.md: Credentials section with GitHub App config example
- internal/cli/init.go: kelos init template with commented githubApp example
- examples/02-task-with-workspace: workspace.yaml and README.md with
  GitHub App alternative
- self-development/README.md: Replace bare comment with actual config example

Closes #436

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 6 files

@gjkim42 gjkim42 added this pull request to the merge queue Feb 28, 2026
@gjkim42
Copy link
Collaborator

gjkim42 commented Feb 28, 2026

/retest

@gjkim42 gjkim42 removed this pull request from the merge queue due to a manual request Feb 28, 2026
@gjkim42 gjkim42 added this pull request to the merge queue Feb 28, 2026
Merged via the queue into main with commit b2232bd Feb 28, 2026
17 of 18 checks passed
@gjkim42 gjkim42 deleted the kelos-task-436 branch February 28, 2026 01:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: GitHub App authentication for Workspaces is undocumented

1 participant