Skip to content

Commit

Permalink
pr suggestions and white screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
pscheit committed Nov 20, 2023
1 parent b09e0d5 commit 80be9eb
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 9 deletions.
Binary file modified Resources/public/img/docs/articles/dependabot-configure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Resources/public/img/docs/articles/dependabot-insights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Resources/public/img/docs/articles/dependabot-jobs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Resources/public/img/docs/articles/dependabot-secret.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 10 additions & 9 deletions docs/dependabot-for-private-packagist.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Set up dependabot with Private Packagist
# Set up Dependabot with Private Packagist
##

[Dependabot](https://dependabot.com) is a security feature from GitHub, that analyses security issues in one of your dependencies. The bot may create Pull Requests to update those dependencies automatically.
[Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide) informs you about vulnerabilities in the dependencies that you use in your repository and can automatically raise pull requests to keep your dependencies up-to-date.

This guide explains how to configure and set up Dependabot if you want to use it for packages hosted on [Private Packagist](https://packagist.com) step by step.

You can use Dependabot to update your private packages hosted on packagist.com in your composer.lock file via Pull Requests as well. This guide explains how to configure and set up Dependabot if you want to use it with Private Packagist step by step.

## Enable Dependabot in GitHub

Start in your GitHub repository and go to “Settings”. In the “Security” section of the sidebar go to “Code security and analysis”, where you can enable Dependabot. In the process, you will create a dependabot.yaml that should look like below. [Refer to this guide on GitHub, for the complete steps](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide#enabling-dependabot-for-your-repository)
Start in your GitHub repository and go to “Settings”. In the “Security” section of the sidebar go to “Code security and analysis”, where you can enable Dependabot. In the process, you will create a dependabot.yaml [as shown as below](#dependabotyaml). Follow [this guide on GitHub](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide#enabling-dependabot-for-your-repository) for the complete steps to enable Dependabot.

![enable dependabot](/Resources/public/img/docs/articles/dependabot-secret.png)

When you click on configure, the dependabot.yaml will be created for you (it will be placed in a folder .github).
When you click on configure, the dependabot.yaml will be created for you in the .github folder.

## dependabot.yaml
### dependabot.yaml

A minimal Dependabot config file would look like this:

Expand All @@ -36,7 +37,7 @@ registries:
Replace the Composer URL `https://repo.packagist.com/acme/` with your own organization's Composer URL on packagist.com. In the example, the repository URL is for the organization on Private Packagist Cloud with the name `acme`.

To grant Dependabot access to the packages on Private Packagist, we need to provide the secret `PRIVATE_PACKAGIST_PASSWORD` in your GitHub repository. In Settings under the section “Security,” there is “Secrets and Variables” for Dependabot.
To grant Dependabot access to the packages on Private Packagist, you need to provide the secret `PRIVATE_PACKAGIST_PASSWORD` in your GitHub repository. In Settings under the section “Security,” there is “Secrets and Variables” for Dependabot.

![Dependabot Secrets](/Resources/public/img/docs/articles/dependabot-secret.png)

Expand All @@ -52,6 +53,6 @@ There is a link “Recent update jobs”, that will show the last jobs from Depe

![Dependabot Jobs](/Resources/public/img/docs/articles/dependabot-jobs.png)

- Make sure, that the secret name, matches the one that you referenced in dependabot.yaml
- Make sure the secret name matches the one that you referenced in dependabot.yaml
- Check if the token from Private Packagist is still valid and has not expired.
- the names under `updates[x].registries` must match a key for credentials in `registries` on the top level of the dependabot.yaml
- Make sure the names under `updates[x].registries` are matching a key for credentials in `registries` on the top level of the [dependabot.yaml](#dependabotyaml).

0 comments on commit 80be9eb

Please sign in to comment.