Install the GitHub App
1
Open GitHub settings in the dashboard
Log in to the Springwinter dashboard and navigate to Settings → GitHub. If you have not yet connected a GitHub account, you will see the Connect GitHub button.
2
Start the GitHub App installation
Click Connect GitHub. You are redirected to the GitHub App installation page on GitHub.com. If you are not already logged into GitHub, you will be prompted to do so.
3
Choose the GitHub account or organization
On the installation page, select the GitHub account — your personal account or any organization you administer — where you want to install the Springwinter App. If you manage multiple organizations, you can install the app separately on each one; each installation is independent.
4
Select repository access
Choose how much access to grant:
- All repositories — Springwinter can see and build every current and future repository in the account or organization.
- Only select repositories — pick specific repositories from the list. You can add more later by revisiting the GitHub App settings.
5
Confirm and return to Springwinter
GitHub asks you to confirm the installation. After you click Install & Authorize, GitHub redirects you back to the Springwinter dashboard automatically. Your installation appears immediately under Settings → GitHub with the account name and the number of repositories accessible.
What Springwinter does with GitHub access
Springwinter requests the minimum permissions required to build and deploy your code:- Read repository contents — to clone your repository at the commit SHA being deployed.
- Read repository metadata — to populate the repository and branch selectors in the dashboard.
- Receive push webhook events — to trigger builds automatically when you push to a configured branch.
A GitHub installation token is created at the start of each build and is not stored by Springwinter after the clone step completes. Your repository credentials are never written to a database or accessible outside the build process.
Auto-deploy behavior
Every resource (web server, worker, or static website) is linked to a specific GitHub repository and branch at creation time. When you push a commit to that branch:- GitHub delivers a push webhook to Springwinter.
- Springwinter queues a new build for the resource.
- The build clones your repository at the new commit, builds the artifact (Docker image or static output), and deploys it.
- The resource’s dashboard card updates to show the new commit SHA and deployment status.