Skip to content

Commit 80be9eb

Browse files
committed
pr suggestions and white screenshots
1 parent b09e0d5 commit 80be9eb

File tree

5 files changed

+10
-9
lines changed

5 files changed

+10
-9
lines changed
104 KB
Loading
13.8 KB
Loading
-2.86 KB
Loading
26.9 KB
Loading

docs/dependabot-for-private-packagist.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1-
# Set up dependabot with Private Packagist
1+
# Set up Dependabot with Private Packagist
22
##
33

4-
[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.
4+
[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.
5+
6+
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.
57

6-
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.
78

89
## Enable Dependabot in GitHub
910

10-
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)
11+
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.
1112

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

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

16-
## dependabot.yaml
17+
### dependabot.yaml
1718

1819
A minimal Dependabot config file would look like this:
1920

@@ -36,7 +37,7 @@ registries:
3637
3738
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`.
3839

39-
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.
40+
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.
4041

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

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

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

55-
- Make sure, that the secret name, matches the one that you referenced in dependabot.yaml
56+
- Make sure the secret name matches the one that you referenced in dependabot.yaml
5657
- Check if the token from Private Packagist is still valid and has not expired.
57-
- the names under `updates[x].registries` must match a key for credentials in `registries` on the top level of the dependabot.yaml
58+
- 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 commit comments

Comments
 (0)