FilesExpand file tree

main

/

check-issue-links.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

117 lines (100 loc) · 4.52 KB

main

/

check-issue-links.yml

Copy path

Top

File metadata and controls

• Code
• Blame

117 lines (100 loc) · 4.52 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

name: Check Issue Links

on:

pull_request_target:

branches:

- main

jobs:

check-issue-links:

runs-on: ubuntu-latest

permissions:

pull-requests: write

steps:

- name: Extract commit messages

env:

GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

run: |

# Fetch the PR's commit messages via the API to avoid checking out untrusted code.

gh api --paginate \

"repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/commits" \

--jq '.[].commit.message' > commit_messages.txt

echo "Extracted commit messages:"

cat commit_messages.txt

- name: Extract referenced issues

run: |

# Extract issue references from commit messages.

referenced_issues=$(grep -Eio '\b(close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved) #[0-9]+' commit_messages.txt \

| grep -Eo '#[0-9]+' \

| tr -d '#' \

| uniq | tr '\n' ',' | sed 's/,$//')

echo "Found referenced issues: $referenced_issues"

# Export referenced issues as an environment variable.

echo "REFERENCED_ISSUES=$referenced_issues" >> $GITHUB_ENV

- name: Get currently linked issues

env:

GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

run: |

# Construct the GraphQL query.

query='

{

repository(owner: "${{ github.repository_owner }}", name: "${{ github.event.repository.name }}") {

pullRequest(number: ${{ github.event.pull_request.number }}) {

id

closingIssuesReferences(first: 50) {

edges {

node {

number

}

}

}

}

}

}'

# Send the GraphQL query using gh API.

response=$(gh api graphql -f query="$query")

# Extract linked issues.

linked_issues=$(echo $response | jq -r '.data.repository.pullRequest.closingIssuesReferences.edges | map(.node.number) | unique | join(",")')

echo "Found currently linked issues: $linked_issues"

# Export linked issues as an environment variable.

echo "LINKED_ISSUES=$linked_issues" >> $GITHUB_ENV

- name: Check if issue references match linked issues

run: |

# Identify missing links.

missing_links=$(comm -23 <(echo "$REFERENCED_ISSUES" | tr ',' '\n' | sort) <(echo "$LINKED_ISSUES" | tr ',' '\n' | sort))

# Identify extra links.

extra_links=$(comm -13 <(echo "$REFERENCED_ISSUES" | tr ',' '\n' | sort) <(echo "$LINKED_ISSUES" | tr ',' '\n' | sort))

# Generate a PR comment.

comment_text=""

if [[ -n "$missing_links" || -n "$extra_links" ]]; then

comment_text+="Issues referenced in commit messages and issues linked to this PR are not in sync."

fi

if [[ -n "$missing_links" ]]; then

comment_text+="\nPlease manually link this PR to the following issues: $missing_links"

fi

if [[ -n "$extra_links" ]]; then

comment_text+="\nPlease manually unlink this PR from the following issues or reference the issues in a commit message: $extra_links"

fi

if [[ -n "$comment_text" ]]; then

echo $comment_text

# Export the comment text as an environment variable.

echo "COMMENT_TEXT=$comment_text" >> $GITHUB_ENV

else

echo "Issues referenced in commit messages and issues linked to this PR are in sync."

fi

- name: Add PR comment

if: always()

env:

GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

run: |

# Fetch all previous comments of this check. Other workflows also comment as this bot, so

# select the comments by their first sentence.

existing_comments=$(gh api --paginate "repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments" --jq '.[] | select(.user.login == "github-actions[bot]" and (.body | startswith("Issues referenced in commit messages and issues linked to this PR are not in sync."))) | .id')

echo "existing comments: $existing_comments"

# Delete existing comments from this bot.

for comment_id in $existing_comments; do

echo "Deleting comment ID $comment_id"

gh api --method DELETE "repos/${{ github.repository }}/issues/comments/$comment_id"

done

if [[ -n "$COMMENT_TEXT" ]]; then

# Add a comment to the PR.

gh pr comment ${{ github.event.pull_request.number }} --body "$(echo -e "$COMMENT_TEXT")"

fi