Skip to content

Commit d92fad3

Browse files
alpetrichcourdentAlex
authored
GitHub app import+export and links (windmill-labs#870)
* github app for git sync * Link + features list * updating screenshot * udpdated images * export import docs * add some links --------- Co-authored-by: Henri Courdent <[email protected]> Co-authored-by: hcourdent <[email protected]> Co-authored-by: Alex <[email protected]>
1 parent 372b199 commit d92fad3

File tree

3 files changed

+15
-2
lines changed

3 files changed

+15
-2
lines changed

docs/advanced/11_git_sync/index.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,4 +204,9 @@ More details at:
204204
description="Develop locally, push to git and deploy automatically to Windmill."
205205
href="/docs/advanced/local_development"
206206
/>
207+
<DocCard
208+
title="GitHub App"
209+
description="Install the Windmill GitHub app to simplify setting up Git sync"
210+
href="/docs/integrations/git_repository#github-app"
211+
/>
207212
</div>

docs/advanced/9_deploy_gh_gl/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ For instance, a [resource](../../core_concepts/3_resources_and_types/index.mdx)
116116
### Setup git sync
117117

118118
1. In Windmill, navigate to the workspace settings and go to the [Git sync](../11_git_sync/index.mdx) tab.
119-
2. Create a `git_repository` [resource](../../core_concepts/3_resources_and_types/index.mdx) with the necessary URL, username, repo name, and a GitHub token.
119+
2. Create a `git_repository` [resource](../../core_concepts/3_resources_and_types/index.mdx) with the necessary URL, username, repo name, and a GitHub token. You can also use a [GitHub app installation](../integrations/git_repository#github-app) to connect a repo to your windmill instance.
120120
3. Generate a fine-grained GitHub [token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) with read and write permissions for content and add it to the Windmill `git_repository` resource.
121121

122122
Your URL should be `https://[USERNAME]:[TOKEN]@github.com/[ORG|USER]/[REPO_NAME].git`

docs/integrations/git_repository.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,12 @@ As a [Windmill workspace admin](https://www.windmill.dev/docs/core_concepts/role
4040

4141
:::warning
4242
You will only be able to use the installation token for [Git sync](../advanced/11_git_sync/index.mdx).
43-
:::
43+
:::
44+
45+
### Importing / Exporting to/from other windmill instance
46+
47+
A GitHub app can only be installed to a GitHub organization once. Hence to associate an installation to multiple windmill instances you need to export the associated JWT token on the source instance using the "Export" button and paste the JWT in the destination instance to import the installation.
48+
49+
:::warning
50+
The JWT token associated to your GitHub app installation is sensitive and has the rights to request a short lived installation token. To revoke the JWT, you need to uninstall the GitHub app from your organization and re-install it to re-associate it with a windmill instance.
51+
:::

0 commit comments

Comments
 (0)