https://github.com/brightspace/d2l-github-workflow-lint

A linter for GitHub Action workflows, specific to D2L
https://github.com/brightspace/d2l-github-workflow-lint

Last synced: 5 days ago
JSON representation

A linter for GitHub Action workflows, specific to D2L

• Host: GitHub
• URL: https://github.com/brightspace/d2l-github-workflow-lint
• Owner: Brightspace
• License: apache-2.0
• Created: 2020-06-22T17:44:55.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-24T17:34:37.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T07:07:34.849Z (about 1 month ago)
• Language: Python
• Size: 11.7 KB
• Stars: 1
• Watchers: 57
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# D2L GitHub Workflow Lint

A linter for GitHub Action workflows, specific to D2L.

## Usage

Add the file `.github/workflows/d2l-github-workflow-lint.yml` (please use this file name) with these contents:

```yaml

name: Workflow Lint

on:

  pull_request:

    paths:

      - '.github/workflows/*.yml'

  schedule:

    # Noon (EST) once every Monday

    - cron: '0 4 * * 1'

jobs:

  lint:

    runs-on: [self-hosted, Linux, AWS]

    timeout-minutes: 2

    steps:

      - name: Checkout

        uses: Brightspace/third-party-actions@actions/checkout

      - name: Lint

        uses: Brightspace/d2l-github-workflow-lint@master

```

Things of note:

* It will run on every PR that touches a workflow file.

* It will run weekly, so that we can audit workflows across our org that don't recieve frequent changes too.