Skip to content

[Docs] Clarify task Git access across GitHub installations - #3617

Draft
roomote-community[bot] wants to merge 1 commit into
developfrom
fix/docs-github-installation-scope-0o9s51kn1bcjr
Draft

roomote-community[bot] wants to merge 1 commit into
developfrom
fix/docs-github-installation-scope-0o9s51kn1bcjr

Conversation

@roomote-community

Copy link
Copy Markdown
Contributor

​Opened on behalf of @mrubens. Follow up by mentioning @roomote, in the web UI, or in Discord.

Related issue

Daily documentation accuracy audit; no linked issue.

Why this PR exists

  • A maintainer explicitly invited this PR in the linked issue or discussion
  • I am a maintainer / this is internal Roomote work

What changed

Explain when task HTTPS Git operations can access repositories across installations of the configured GitHub App. Distinguish that access from the task's single-installation primary gh/API credential, explicit environment constraints, and task delivery tools. Mark the behavior as develop-only after v1.19.4.

Why this change was made

The exact October 28 03:00:36.617Z–October 29 03:00:36.617Z audit found five merged PRs (#3611–#3615), all on develop and absent from released main/v1.19.4 (01f01c97). #3611 and #3612 include their relevant docs; #3613 restores task startup with multiple organizations; #3614 adds repository-scoped Git credentials without documenting their distinction from API access. #3615 is an internal dependency patch. This fills the #3614 gap without promising the feature in the current release.

The complete coverage and evidence report records inspected commits, behavior, docs, duplicate checks and limitations. Existing pending audit fixes, including #3594's unrelated edits to this page, are not duplicated.

Impact

Documentation only, one page. Readers can distinguish task Git access across organizations from API and environment boundaries. No runtime or configuration changes.

How it was tested

  • mise exec -- pnpm --filter @roomote/docs check passed on the final text: Mintlify 4.2.650 validation and broken-link checking.
  • mise exec -- pnpm --filter @roomote/docs check-cookbook-index passed, seven recipes; no generated drift.
  • git diff --check and normal pre-push gates passed: oxlint, residual web/worker ESLint, all 27 typecheck tasks, and Knip.
  • Commit-time Judgement reported incomplete for two prose rules because evidence/judgment collection failed; the commit was allowed. These rules were manually reviewed, but automated judgment is not claimed to have passed.
  • Browser proof was blocked: the configured local Mintlify page displayed Internal Server Error, with missing generated Next.js files in its logs. Restarting the existing supervised preview once did not restore the page during the bounded check. No screenshots were retained and no rendered-page verification is claimed.
  • Behavior was checked against implementation and existing token-scope test cases, not live external GitHub organization authorization/clone/push. Full Vitest and formatting-inclusive pnpm lint / pnpm check-types were not run for this docs-only change.

Checklist

  • The PR title follows the repo convention: [Fix], [Feat], [Improve], [Refactor], [Docs], or [Chore] followed by a user-facing description
  • This PR is small and scoped to one change
  • pnpm lint and pnpm check-types pass locally
  • I added tests or included a clear manual validation note above
  • I removed secrets, tokens, private keys, and customer data from code, logs, and screenshots
  • If this change should appear in the changelog, I ran pnpm changeset

No changeset is needed for this documentation-only clarification.

@roomote-community

roomote-community Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor Author

No issues introduced by this documentation change found. Checked the new Git/API credential distinction, unavailable-installation handling, environment restriction, and release caveat against the implementation. Current-head docs validation, tests, lint, and type checks passed; Docker and JavaScript CodeQL checks were still running when inspected. See session

Reviewed b2b09de

@roomote-roomote roomote-roomote Bot mentioned this pull request Oct 29, 2026
8 of 11 tasks

This branch has not been deployed

No deployments
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