kubernetes-sigs/kubebuilder-release-tools

Create a Custom action to provide the shell script to validate the PR titles

Ouverte

#62 ouverte le 17 sept. 2024

 (1 commentaire) (0 réaction) (1 personne assignée)Go (25 forks)auto 404
help wanted

Métriques du dépôt

Stars
 (20 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Context:

Refer to this PR. Discussion thread: Slack thread.

Description: We need to create a custom GitHub action that provides a shell script to validate PR titles. This would ensure consistency in PR naming conventions and improve the overall workflow.

Idea

We might need add here:

name: "PR Title Validator"
description: "Validates PR titles based on predefined conventions."
inputs:
  github-token:
    description: "GitHub Token"
    required: true
runs:
  using: "bash"
  main: "entrypoint.sh" <-- And add the shell script


therefore, people could use it like

jobs:
  pr-title-check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      - name: Run PR Title Validator from kubebuilder-release-tools
        uses: kubernetes-sigs/kubebuilder-release-tools/.github/actions/pr-title-checker@main
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

Then we need to

Guide contributeur