Skip to content

Commit

Permalink
Dependabot package-ecosystem clarification about combined usage (gith…
Browse files Browse the repository at this point in the history
…ub#15790)

* add other supported package managers

* add missing word

* fix another typo

* rewrite

* polish new content

* fix bad variabler syntax

* try again

* more polishing

* Update data/reusables/dependabot/supported-package-managers.md

Co-authored-by: Philip Harrison <[email protected]>

* Update data/reusables/dependabot/supported-package-managers.md

Co-authored-by: Felicity Chapman <[email protected]>

* add Note at the start of the note

* manually update syntax for variables

* update yet another variable syntax

* and again

* Add Note again to note

Co-authored-by: Philip Harrison <[email protected]>
Co-authored-by: Felicity Chapman <[email protected]>
  • Loading branch information
3 people authored Oct 1, 2020
1 parent 26097c6 commit ed8296c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ In general, security updates use any configuration options that affect pull requ

### `package-ecosystem`

**Required** You add one `package-ecosystem` element for each one package manager that you want {% data variables.product.prodname_dependabot %} to monitor for new versions. The repository must also contain a dependency manifest or lock file each of these package managers. If you want to enable vendoring for a package manager that supports it, the vendored dependencies must be located in the required directory. For more information, see [`vendor`](#vendor) below.
**Required** You add one `package-ecosystem` element for each package manager that you want {% data variables.product.prodname_dependabot_short %} to monitor for new versions. The repository must also contain a dependency manifest or lock file for each of these package managers. If you want to enable vendoring for a package manager that supports it, the vendored dependencies must be located in the required directory. For more information, see [`vendor`](#vendor) below.

{% data reusables.dependabot.supported-package-managers %}

Expand Down Expand Up @@ -308,7 +308,7 @@ updates:
{% note %}
{% data variables.product.prodname_dependabot_version_updates %} can't run version updates for any dependencies in manifests containing private git dependencies or private git registries, even if you add the private dependencies to the `ignore` option of your configuration file. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-github-dependabot#supported-repositories-and-ecosystems)."
**Note**: {% data variables.product.prodname_dependabot_version_updates %} can't run version updates for any dependencies in manifests containing private git dependencies or private git registries, even if you add the private dependencies to the `ignore` option of your configuration file. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-github-dependabot#supported-repositories-and-ecosystems)."

{% endnote %}

Expand Down
12 changes: 12 additions & 0 deletions data/reusables/dependabot/supported-package-managers.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,15 @@ npm: `npm` |
NuGet: `nuget` |
pip: `pip` |
Terraform: `terraform` |

{% note %}

**Note**: {% data variables.product.prodname_dependabot_short %} also supports the following package managers:

-`yarn` (v1 only) (specify `npm`)

-`pipenv`, `pip-compile`, and `poetry` (specify `pip`)

For example, if you use `poetry` to manage your Python dependencies and want {% data variables.product.prodname_dependabot_short %} to monitor your dependency manifest file for new versions, use `package-ecosystem: "pip"` in your *dependabot.yml* file.

{% endnote %}

0 comments on commit ed8296c

Please sign in to comment.