Skip to content

feat(compose): add optional GitHub sync service - #332

Open
YannJY02 wants to merge 2 commits into
hcengineering:mainfrom
YannJY02:contrib/github-sync-profile
Open

feat(compose): add optional GitHub sync service#332
YannJY02 wants to merge 2 commits into
hcengineering:mainfrom
YannJY02:contrib/github-sync-profile

Conversation

@YannJY02

Copy link
Copy Markdown

Summary

  • bundle the GitHub synchronization service behind the opt-in github Compose profile
  • configure the front end and webhook proxy without requiring manual Compose or nginx edits
  • use the internal collaborator endpoint and avoid publishing the GitHub service port
  • separate GitHub App variables from the existing GitHub OAuth variables
  • preserve the optional settings when generating huly_v7.conf
  • document the issue_comment subscription required for issue and pull request comments

Default deployments remain unchanged: the service is disabled until COMPOSE_PROFILES=github is configured, and nginx resolves the optional service only when a request reaches the GitHub route.

Validation

  • bash -n setup.sh
  • sh -n setup.sh
  • git diff --check
  • validated both default and github profile service lists with docker compose config --services
  • asserted the rendered service uses ws://collaborator:3078, Redpanda, and no host port
  • started and validated nginx without a github DNS target to verify the default profile remains available
  • verified multiline GitHub App private keys survive config generation

No credentials, private deployment URLs, or generated local configuration are included.

Refs #179, #296, #297. Related to #300.

Resolve the profile-gated GitHub service through Docker DNS at request time so nginx starts when the profile is disabled. Document the issue_comment webhook subscription required for issue and pull request comments.
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