Skip to content

docs(bootstrap): add missing guide for github apps - #2712

Merged
matheuscscp merged 2 commits into
fluxcd:mainfrom
tuunit:docs/add-missing-github-app-bootstrap-guide
Nov 5, 2026
Merged

matheuscscp merged 2 commits into
fluxcd:mainfrom
tuunit:docs/add-missing-github-app-bootstrap-guide

Conversation

@tuunit

@tuunit tuunit commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

Back in 2025 GitHub App support was added and a blog post was published how to use it: https://fluxcd.io/blog/2025/04/flux-operator-github-app-bootstrap/

But the bootstrap guide is missing a section on how to utilize / configure GitHub App bootstrapping

@matheuscscp matheuscscp left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for this PR!

I would omit mentions to --app-installation-id entirely now that --app-installation-owner is available and is much easier for users to find out. I would consider static installation ID a legacy feature after the introduction of lookup via owner.

Signed-off-by: Jan Larwig <jan.larwig@digits.schwarz>
@tuunit
tuunit force-pushed the docs/add-missing-github-app-bootstrap-guide branch from 1ea0cdb to 9feac87 Compare November 5, 2026 13:48
@tuunit

tuunit commented Nov 5, 2026

Copy link
Copy Markdown
Contributor Author

@matheuscscp thanks for the quick review. I removed the section about the CLI and replaced all references of app-installation-id with app-installation-owner :)

@matheuscscp

Copy link
Copy Markdown
Member

Thanks! You missed removing step 10 from Register a GitHub App.

Also, we can replace --app-id with the new --app-client-id everywhere as well, looks like GitHub is now favoring client ID instead of app ID:

https://github.blog/changelog/2024-05-01-github-apps-can-now-use-the-client-id-to-fetch-installation-tokens/

@tuunit

tuunit commented Nov 5, 2026

Copy link
Copy Markdown
Contributor Author

Yeah I was already thinking about app-id vs app-client-id but as its still in place after 2 years, I was like 🤷🏼 lets keep it for now as long as they support it but if you would like to only show the best way forward

…e install id

Signed-off-by: Jan Larwig <jan.larwig@digits.schwarz>

@matheuscscp matheuscscp left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! 🚀

Thanks @tuunit!

@matheuscscp matheuscscp added area/docs Documentation related issues and pull requests backport:v2-10 To be backported to v2-10 labels Nov 5, 2026
@matheuscscp
matheuscscp merged commit 0542ba4 into fluxcd:main Nov 5, 2026
5 checks passed
@fluxcdbot

Copy link
Copy Markdown
Member

Successfully created backport PR for v2-10:

@tuunit
tuunit deleted the docs/add-missing-github-app-bootstrap-guide branch November 5, 2026 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation related issues and pull requests backport:v2-10 To be backported to v2-10

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants