-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added custom action for PR title checker #63
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
#!/bin/bash | ||
|
||
# Copyright 2024 The Kubernetes Authors. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. By last we should either deprecated the Golang code with annotations/comments since we are replacing the old implementation with the shell script. |
||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
# Define regex patterns | ||
WIP_REGEX="^\W?WIP\W" | ||
TAG_REGEX="^\[[[:alnum:]\._-]*\]" | ||
PR_TITLE="$1" | ||
|
||
# Trim WIP and tags from title | ||
trimmed_title=$(echo "$PR_TITLE" | sed -E "s/$WIP_REGEX//" | sed -E "s/$TAG_REGEX//" | xargs) | ||
|
||
# Normalize common emojis in text form to actual emojis | ||
trimmed_title=$(echo "$trimmed_title" | sed -E "s/:warning:/⚠/g") | ||
trimmed_title=$(echo "$trimmed_title" | sed -E "s/:sparkles:/✨/g") | ||
trimmed_title=$(echo "$trimmed_title" | sed -E "s/:bug:/🐛/g") | ||
trimmed_title=$(echo "$trimmed_title" | sed -E "s/:book:/📖/g") | ||
trimmed_title=$(echo "$trimmed_title" | sed -E "s/:rocket:/🚀/g") | ||
trimmed_title=$(echo "$trimmed_title" | sed -E "s/:seedling:/🌱/g") | ||
|
||
# Check PR type prefix | ||
if [[ "$trimmed_title" =~ ^⚠ ]] || [[ "$trimmed_title" =~ ^✨ ]] || [[ "$trimmed_title" =~ ^🐛 ]] || [[ "$trimmed_title" =~ ^📖 ]] || [[ "$trimmed_title" =~ ^🚀 ]] || [[ "$trimmed_title" =~ ^🌱 ]]; then | ||
echo "PR title is valid: $trimmed_title" | ||
exit 0 | ||
else | ||
echo "Error: No matching PR type indicator found in title." | ||
echo "You need to have one of these as the prefix of your PR title:" | ||
echo "- Breaking change: ⚠ (:warning:)" | ||
echo "- Non-breaking feature: ✨ (:sparkles:)" | ||
echo "- Patch fix: 🐛 (:bug:)" | ||
echo "- Docs: 📖 (:book:)" | ||
echo "- Release: 🚀 (:rocket:)" | ||
echo "- Infra/Tests/Other: 🌱 (:seedling:)" | ||
exit 1 | ||
fi |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
name: "PR Title Validator" | ||
description: "Validates PR titles based on predefined conventions." | ||
inputs: | ||
github-token: | ||
description: "GitHub Token" | ||
required: true | ||
runs: | ||
using: "bash" | ||
main: "../pr-title-checker.sh" |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -51,6 +51,10 @@ jobs: | |
uses: kubernetes-sigs/kubebuilder-release-tools@v0.2 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The above way will no longer any more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Okay. |
||
- 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 }} | ||
``` | ||
|
||
The code that actually runs lives in [verify](/verify), while | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to change the GitHub action used here to verify the PR title
to either test the PR title of this repo with the new solution so that we can ensure that works