How to lint PRs and welcome contributors using GitHub Actions

Motivation

Expanding the @open-sauced ecosystem, it became tedious to apply all the necessary tooling available in open-sauced/open-sauced to newly created repositories and synchronising existing ones with minor updates.

Having github actions reusable workflows, we figured it would make a lot of sense to centralise our workflows and referencing them in other repositories.

The process was very simple and we want to showcase how to apply a similar process for your own organisation.

My Workflow

name: "Compliance"

on:
  pull_request_target:
    types:
      - opened
      - edited
      - synchronize

permissions:
  pull-requests: write

jobs:
  compliance:
    uses: open-sauced/open-sauced/.github/workflows/compliance.yml@main

The full workflow is available here: .github/workflows/compliance.yml

Submission Category: Maintainer Must-Haves

Yaml File or Link to Code

Live repository using this workflow:

open-sauced / conventional-commit

commit binary powered by commitizen with conventional commit standard

@open-sauced/conventional-commit

Never miss a conventional commit with commitizen running on npx.

📦 Install

This package is binary and doesn't require installation however you can add it to your repository as a devDependency:

npm install --save-dev @open-sauced/conventional-commit

🚀 Usage

All you have to do is run the script next to your package.json:

npx @open-sauced/conventional-commit
# or
npx conventional-commit

🔧 Configuration

The most common use case for this package is to run it instead of the git commit command inside your npm scripts:

{
  "scripts": {
    "push": "npx @open-sauced/conventional-commit"
  }
}

or

{
  "scripts": {
    "push": "npx conventional-commit"
  }
}

If you want to ensure local-only usage:

{
  "scripts": {
    "push": "conventional-commit"
  }
}

🤝 Contributing

We encourage you to contribute to Open Sauced! Please check out the Contributing guide for guidelines about how to proceed.

If…

View on GitHub

Yaml file link:
@open-sauced/open-sauced/.github/workflows/compliance.yml

Additional Resources / Info

Here are all the open source actions we are using to power this compliance workflow:

• actions/first-interaction@v1 - welcomes first time contributors and invites them to @open-sauced discord
• amannn/action-semantic-pull-request@v3.4.0 - ensures pull request title matches conventional commits specification
• mtfoley/pr-compliance-action@v0.2.1 - check PR for compliance on title, linked issues, and files changed

Be sure to include the DEV usernames of your collaborators:

Matthew FoleyFollow

I write code for fun, and sometimes for work