-
Notifications
You must be signed in to change notification settings - Fork 67
🌱 Replace Depecated Action to validate the PR Title with script #1541
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
Closed
camilamacedo86
wants to merge
1
commit into
operator-framework:main
from
camilamacedo86:fix-pr-title-check
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,7 +7,10 @@ jobs: | |
runs-on: ubuntu-latest | ||
name: Verify PR title | ||
steps: | ||
- name: Verify PR title | ||
uses: kubernetes-sigs/[email protected] | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
- name: Verify PR title | ||
id: get_title | ||
run: echo "title=${{ github.event.pull_request.title }}" >> $GITHUB_ENV | ||
- name: Run Check | ||
id: check_title | ||
run: | | ||
./hack/test/pr-title.sh "${{ env.title }}" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
#!/bin/bash | ||
|
||
# Copyright 2024 The Kubernetes Authors. | ||
# | ||
# This file is copied from: | ||
# https://github.com/kubernetes-sigs/kubebuilder/blob/master/test/pr-title-checker.sh | ||
# | ||
# 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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
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.
Just wondering if something like:
would be enough...
do we want to post success for [WIP] 🌱 ... ?
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.
I think we are still failing when WIP is
The rules ,I think would still the same: kubernetes-sigs/[email protected]
@joe suggested we create an action there in the repo as well
I just had no effort to maintain the kubebuilder-release-tools
But let's put it in
/hold
I will see if I can change there.
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.
I tested it real quick and it seems to let [WIP] titles through:
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.
could we just fork the action repo and use that?
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.
Do you mean to start to maintain that inside of operator-framework?