https://github.com/marocchino/validate-dependabot

validate dependabot yaml
https://github.com/marocchino/validate-dependabot

Last synced: 7 days ago
JSON representation

validate dependabot yaml

• Host: GitHub
• URL: https://github.com/marocchino/validate-dependabot
• Owner: marocchino
• License: mit
• Created: 2021-02-18T22:02:54.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-08T03:40:08.000Z (about 1 month ago)
• Last Synced: 2024-10-26T10:49:41.030Z (12 days ago)
• Language: TypeScript
• Size: 3.69 MB
• Stars: 23
• Watchers: 3
• Forks: 5
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        


  



This action tests the dependabot.yml against the official JSON schema. It does not detect all invalid dependabot files as dependabot has extra validation beyond the JSON schema.

## Why?

If you get a validation error when editing your config, you won't know if there's a problem until the next dependabot runs.

Even if the cycle is long and the alarm is not set, it may be detected much later.

This library allows you to find some problems in the PR stage.

## Usage

```yaml

name: dependabot validate

on:

  pull_request:

    paths:

      - '.github/dependabot.yml'

      - '.github/workflows/dependabot-validate.yml'

jobs:

  validate:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: marocchino/validate-dependabot@v3

        id: validate

      - uses: marocchino/sticky-pull-request-comment@v2

        if: always()

        with:

          header: validate-dependabot

          message: ${{ steps.validate.outputs.markdown }}

```

## Inputs

### `path`

**Required** path of config file. Default `".github/dependabot.yml"`.

### `success_message`

**Required** display on success. Default `"✅dependabot config looks good 👍"`.

### `failure_message`

**Required** display on failure. Default `"🚫 dependabot errors"`.

## Outputs

### `raw`

response body as json string

### `markdown`

errors as markdown table

## Any problem?

Feel free to report issues. 😃