Skip to content

Commit 1e75258

Browse files
authored
Tweak replaces-base instructions so users can copy/paste it (#55677)
1 parent 03336fc commit 1e75258

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

content/code-security/dependabot/maintain-dependencies/removing-dependabot-access-to-public-registries.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You can configure {% data variables.product.prodname_dependabot %} to access _on
3333

3434
## Bundler
3535

36-
To configure the Bundler ecosystem to only access private registries, you can set `replaces-base` as `true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#rubygems-server).
36+
To configure the Bundler ecosystem to only access private registries, you can set `replaces-base: true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#rubygems-server).
3737

3838
The Bundler ecosystem additionally requires a `Gemfile` file with the private registry URL to be checked into the repository.
3939

@@ -72,7 +72,7 @@ In the `Dockerfile` file, add the image name in the format of `IMAGE[:TAG]`, whe
7272

7373
**Option 2**
7474

75-
Set `replaces-base` as `true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#docker-registry). The registry configured with the `replaces-base` can be used as a mirror or a pull through cache. For further details, see [Registry as a pull through cache](https://docs.docker.com/registry/recipes/mirror/) in the Docker documentation.
75+
Set `replaces-base: true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#docker-registry). The registry configured with the `replaces-base` can be used as a mirror or a pull through cache. For further details, see [Registry as a pull through cache](https://docs.docker.com/registry/recipes/mirror/) in the Docker documentation.
7676

7777
## Gradle
7878

@@ -81,7 +81,7 @@ To configure the Gradle ecosystem to only access private registries, you can use
8181
Define the private registry configuration in a `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#maven-repository).
8282

8383
> [!NOTE]
84-
> Remove replaces-base: true from the configuration file.
84+
> Remove `replaces-base: true` from the configuration file.
8585

8686
Additionally, you also need to specify the private registry URL in the `repositories` section of the `build.gradle` file.
8787

@@ -101,7 +101,7 @@ To configure the Maven ecosystem to only access private registries, you can use
101101

102102
**Option 1**
103103

104-
Set `replaces-base` as `true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#maven-repository).
104+
Set `replaces-base: true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#maven-repository).
105105

106106
**Option 2**
107107

@@ -141,7 +141,7 @@ The npm ecosystem additionally requires a `.npmrc` file with the private registr
141141

142142
**Option 2**
143143

144-
If there is no global registry defined in an `.npmrc` file, you can set `replaces-base` as `true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#npm-registry).
144+
If there is no global registry defined in an `.npmrc` file, you can set `replaces-base: true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#npm-registry).
145145

146146
> [!NOTE]
147147
> For scoped dependencies (`@my-org/my-dep`), {% data variables.product.prodname_dependabot %} requires that the private registry is defined in the project's `.npmrc` file. To define private registries for individual scopes, use `@myscope:registry=https://private_registry_url`.
@@ -184,7 +184,7 @@ If the `yarn.lock` file doesn't list the private registry as the dependency sour
184184

185185
**Option 3**
186186

187-
If there is no global registry defined in a `.yarnrc` file, you can set `replaces-base` as `true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#npm-registry).
187+
If there is no global registry defined in a `.yarnrc` file, you can set `replaces-base: true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#npm-registry).
188188

189189
> [!NOTE]
190190
> For scoped dependencies (`@my-org/my-dep`), {% data variables.product.prodname_dependabot %} requires that the private registry is defined in the project's `.npmrc` file. To define private registries for individual scopes, use `@myscope:registry=https://private_registry_url`.
@@ -305,15 +305,15 @@ Add the private registry URL to the `[global]` section of the `pip.conf` file an
305305

306306
**Option 2**
307307

308-
Set `replaces-base` as `true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#python-index).
308+
Set `replaces-base: true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#python-index).
309309

310310
### Pip-compile
311311

312312
To configure the Pip-compile ecosystem to only access private registries, you can use these configuration methods.
313313

314314
**Option 1**
315315

316-
Set `replaces-base` as `true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#python-index).
316+
Set `replaces-base: true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#python-index).
317317

318318
**Option 2**
319319

@@ -346,7 +346,7 @@ name = "pypi"
346346

347347
### Poetry
348348

349-
To configure Poetry to only access private registries, set `replaces-base` as `true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#python-index).
349+
To configure Poetry to only access private registries, set `replaces-base: true` in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#python-index).
350350

351351
Add the private registry url to the `[[tool.poetry.source]]` section of the `pyproject.toml` file and checked it in the repository.
352352

0 commit comments

Comments
 (0)