Skip to content

Commit 68d7fee

Browse files
mateuscapdiegoguerradTomFern
authored
Documentation update: Deploy Key policy "enabled"/"disabled" (#648)
## 📝 Description #633 ## ✅ Checklist - [x] I have tested this change - [x] This change requires documentation update --------- Co-authored-by: Diego Guerra <[email protected]> Co-authored-by: Tomas Fernandez <[email protected]>
1 parent d8290da commit 68d7fee

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/docs/using-semaphore/connect-github.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,38 @@ A deploy key can be invalidated if:
120120

121121
:::
122122

123+
### Verify deploy key settings on GitHub {#deploy-key-github}
124+
125+
GitHub recently changed the default setting for Deploy keys, which may now be set to Disabled for new organizations. When this setting is disabled, Semaphore cannot create or connect projects from GitHub repositories.
126+
127+
If you encounter issues connecting Semaphore to your GitHub repository (for example, projects failing to create or the connection breaking), please verify your deploy key configuration, depending on the type of GitHub account:
128+
129+
#### GitHub organization accounts:
130+
131+
1. Go to your organization’s settings page on GitHub: https://github.com/organizations/ORGANIZATION_NAME/settings/deploy_keys
132+
1. Under **Security → Deploy keys**, check the **Default policy** setting.
133+
1. If the default option is **Disabled**, change it to **Enabled**.
134+
135+
<img width="626" height="234" alt="Image" src="https://github.com/user-attachments/assets/ca603af3-cbbc-47b2-b566-f1912704b8fe" />
136+
137+
1. Once updated, retry creating or reconnecting your project on Semaphore.
138+
139+
#### GitHub Enterprise Accounts:**
140+
141+
For GitHub Enterprise Cloud users, deploy key policies are controlled at the enterprise level. A user with Admin permissions must enable deploy keys.
142+
143+
1. Log in to your GitHub Enterprise Cloud account as an admin.
144+
145+
1. Follow the instructions in GitHub’s documentation: [Enforcing a policy for deploy keys in your enterprise](https://docs.github.com/en/enterprise-cloud@latest/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deploy-keys)
146+
147+
- In the top-right corner of GitHub, click your profile picture.
148+
- Click on **Your enterprise/Your enterprises** and select your organization.
149+
- Click on **Policies > Member privileges**.
150+
- Under **Deploy keys**, review the information about changing the setting, select a policy, and save.
151+
152+
1. Once updated, retry creating or reconnecting your project on Semaphore.
153+
154+
123155
### Verify webhook health {#webhook}
124156

125157
Semaphore uses a webhook to detect changes in your repository. When the webhook is broken, Semaphore can't trigger new workflows.

0 commit comments

Comments
 (0)