Installation
- Authenticate into GitHub
- Grant Windmill access to GitHub
- Select the GitHub instance you’d like to connect (you can always add multiple instances)
Connected data
Connecting GitHub to Windmill will grant read access to the following:- Actions
- Administration
- Code
- Commit statuses
- Deployments
- Discussions
- Environments
- Issues
- Members
- Metadata
- Organization administration
- Pages
- Pull requests
- Repository hooks
- Repository projects
Username mapping
GitHub uses specific usernames that don’t always map to employee email addresses. If you see GitHub activities that aren’t associated with a team member or are associated with the wrong team member, Windmill Admins can fix this. To update username mapping:- Go to Settings in Windmill
- Select the Connections tab
- Select GitHub
- Select the Mapping tab to see all usernames and their current mappings
- Click Update mapping to edit assignments
Permissions
You need to be a GitHub Owner or Manager to connect GitHub.FAQs
Why do I need to sign my commits?
Why do I need to sign my commits?
Signing your Git commits proves that you created the commit and keeps your code secure. It’s like adding your signature to your work. For Windmill, signing commits ensures all your code contributions are properly reflected on the platform.
Troubleshooting commit signing
Troubleshooting commit signing
If you’re having issues with commit signing, these resources can help:
- GitHub: Managing Commit Signature Verification - Complete guide to all aspects of commit signing
- GitHub: About Commit Signature Verification - Learn why verification is important
- GitHub: Signing Commits - Step-by-step guide for signing commits
- GitHub: Displaying Verification Status - How to enable vigilant mode
- Dev.to: GitHub Commit Verification Using SSH - Practical tutorial for SSH-based verification
Why aren't my GitHub activities showing up?
Why aren't my GitHub activities showing up?
If GitHub activities aren’t appearing for you or your team members, check the username mapping in Settings > Connections > GitHub > Mapping tab. GitHub usernames might not match email addresses, so they need to be manually mapped to the correct employees.