Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 2.79 KB

use_dependabot.md

File metadata and controls

76 lines (58 loc) · 2.79 KB

Use dependabot

dependabot is a bot, which monitors your dependencies. It automatically creates PRs with a given interval, if the dependencies are updated.

Please consult the documentation to see if your language is supported.

I first saw it in action for a Rust based repository. Check the PRs marked dependencies.

I have enabled the Dockerfile support for two of my repositories, first one being [ebirah](https://github.com/jonasbn/ebirah). The second one has support for pip(Python) enabled as well.

Too bad there is no Perl support :-(

The setup is pretty basic:

Dockerfile example:

# Basic dependabot.yml file with
# minimum configuration for single package manager

version: 2
updates:
  # Enable version updates for Docker
  - package-ecosystem: "docker"
    # Look for a `Dockerfile` in the `root` directory
    directory: "/"
    # Check for updates once a week
    schedule:
      interval: "weekly"

And example with two configurations:

# Basic dependabot.yml file with
# minimum configuration for two package managers

version: 2
updates:
  # Enable version updates for pip (Python)
  - package-ecosystem: "pip"
    directory: "/"
    schedule:
      interval: "weekly"
    # Only allow updates to the lockfile for pip and
    # ignore any version updates that affect the manifest
    versioning-strategy: lockfile-only

  # Enable version updates for Docker
  - package-ecosystem: "docker"
    # Look for a `Dockerfile` in the `root` directory
    directory: "/"
    # Check for updates once a week
    schedule:
      interval: "weekly"

In addition I can recommend, the configuration for GitHub Actions:

  # Enable version updates for Actions
  - package-ecosystem: "github-actions"
    # Look for `.github/workflows` in the `root` directory
    directory: "/"
    # Check for updates once a week
    schedule:
      interval: "weekly"

The dependabot.yml file should be saved in the .github/ directory, please consult the documentation.

Resources and References