kubernetes-sigs/kubebuilder-release-tools

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

开放

#62 创建于 2024年9月17日

 (1 条评论) (0 个反应) (1 位负责人)Go (25 个派生)auto 404
help wanted

仓库指标

星标
 (20 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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

贡献者指南