Skip to content

Commit d708ec1

Browse files
authored
Merge pull request #131 from packagist/general-webhook-setup
General webhook setup
2 parents bbb7917 + 292313d commit d708ec1

File tree

3 files changed

+29
-0
lines changed

3 files changed

+29
-0
lines changed
Loading

docs/setup.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,27 @@ For Private Packagist to be able to access repositories that require authenticat
142142
143143
Note: Even though you need to select a domain when you create a credential Private Packagist will not automatically apply the credential for all HTTP calls to that domain. Private Packagist will only suggest it where it might be useful. Therefore it is important that you explicitly select it when you add the credential or else Private Packagist will not be able to import the repository.
144144
145+
### General webhook setup
146+
147+
Webhooks are automatically configured for packages from GitHub, GitLab, and Bitbucket when added through a synchronization or added by URL with a credential with permissions to configure a webhook.
148+
149+
See integration specific information on webhooks here: [Integrations](/features/integration-github-bitbucket-gitlab)
150+
151+
For other code-hosting platforms or custom setups, you can also configure the webhook manually.
152+
153+
Find your unique webhook URL on the package details page:
154+
155+
![Webhook Setup](/Resources/public/img/docs/integration-setup/webhook-setup.png)
156+
157+
Configure your webhook to trigger on the following repository events:
158+
- On each pus
159+
- When a branch is created
160+
- When a branch is deleted
161+
- When a tag is created
162+
- When a tag is deleted
163+
164+
These events ensure your package metadata stays synchronized with your repository changes, enabling automatic updates when you publish new versions or modify your codebase.
165+
145166
### Add a forked VCS repository
146167
147168
When adding a fork to Private Packagist it can happen that the original package was already added. Since Composer cannot load multiple packages by the same name from one URL, the new package will be marked as uninstallable with Composer due to a conflicting name. You will have to delete the original package and then add your fork. Once the changes of the fork are merged back upstream and you are ready to delete the fork you can also delete the package in Private Packagist. Private Packagist will then automatically mirror the original package from packagist.org again.
@@ -257,3 +278,4 @@ Once all the repository entries have been added to Private Packagist the setup i
257278
}
258279
}
259280
```
281+

features/integration-github-bitbucket-gitlab.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,10 @@ Private Packagist integrates with the following systems:
6868
* Webhooks:
6969
* Users need to [create a Service Hook](https://docs.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops) using the generic hook URL from the package page
7070
* Select the "Code pushed" event (includes commits and tags) and the repository that matches the package. No authentication or additional configuration is necessary.
71+
72+
#### Beanstalk
73+
* Code Credentials: Grant us access via SSH key
74+
* Webhooks:
75+
* Users need to [create a Modular Webhooks Integration](https://support.beanstalkapp.com/article/56-modular-webhooks-integration) using the generic hook URL from the package page
76+
* Following events need to be selected: `push`, `create_branch`, `delete_branch`, `create_tag`, `delete_tag`
77+

0 commit comments

Comments
 (0)