FilesExpand file tree

 main

/

detect-api-changes.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

98 lines (80 loc) · 3.69 KB

 main

/

detect-api-changes.yml

Copy path

Top

File metadata and controls

• Code
• Blame

98 lines (80 loc) · 3.69 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

name: Detect API Changes

on:

# pull_request_target is used instead of pull_request so that the workflow has write access

# (to post comments and apply labels) even when triggered by fork PRs.

#

# SECURITY: this workflow must never checkout or execute any code from the PR branch.

# Doing so would allow malicious PRs to exfiltrate secrets. All we use from the PR

# is github.event.pull_request.number (an integer), which is safe.

pull_request_target:

types: [opened, synchronize, reopened, ready_for_review]

permissions: {}

jobs:

detect-api-changes:

name: Detect API surface area changes

if: github.repository == 'open-telemetry/opentelemetry-java'

runs-on: ubuntu-latest

steps:

- uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0

id: otelbot-token

with:

app-id: ${{ vars.OTELBOT_APP_ID }}

private-key: ${{ secrets.OTELBOT_PRIVATE_KEY }}

- name: Check for API changes and update PR

env:

GH_TOKEN: ${{ steps.otelbot-token.outputs.token }}

PR_NUMBER: ${{ github.event.pull_request.number }}

REPO: ${{ github.repository }}

HEAD_REF: ${{ github.event.pull_request.head.ref }}

run: |

MARKER="<!-- api-change-detector -->"

# Get list of apidiff files changed in this PR.

# otelbot/* PRs (release version bumps, post-release updates) only change the version

# header in apidiff files — treat them as having no API changes so the cleanup path below runs.

if [[ "$HEAD_REF" == otelbot/* ]]; then

api_files=""

else

api_files=$(gh api "repos/${REPO}/pulls/${PR_NUMBER}/files" --paginate \

--jq '.[] | select(.filename | startswith("docs/apidiffs/current_vs_latest/")) | .filename')

fi

# Find existing bot comment (if any)

comment_id=$(gh api "repos/${REPO}/issues/${PR_NUMBER}/comments" --paginate \

--jq ".[] | select(.body | startswith(\"${MARKER}\")) | .id" | head -1)

if [[ -z "$api_files" ]]; then

echo "No API diff files changed."

# Remove label if present (ok to fail if label doesn't exist on PR)

gh pr edit "$PR_NUMBER" --repo "$REPO" --remove-label "api-change" 2>/dev/null || true

# Delete existing comment if present

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

gh api --method DELETE "repos/${REPO}/issues/comments/${comment_id}"

echo "Removed stale API change comment."

fi

exit 0

fi

echo "API diff files changed:"

echo "$api_files"

# Add label

gh pr edit "$PR_NUMBER" --repo "$REPO" --add-label "api-change"

# Build bulleted module list

modules=$(echo "$api_files" \

| sed 's|docs/apidiffs/current_vs_latest/||' \

| sed 's|\.txt$||' \

| sort \

| sed 's/^/- /')

BODY=$(cat <<EOF

${MARKER}

## :warning: API changes detected — additional maintainer review required

@jack-berg @jkwatson

This PR modifies the public API surface area of the following module(s):

${modules}

Please review the changes in \`docs/apidiffs/current_vs_latest/\` carefully before approving.

EOF

)

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

echo "Updating existing comment ${comment_id}"

gh api --method PATCH "repos/${REPO}/issues/comments/${comment_id}" \

--field body="$BODY"

else

echo "Creating new comment"

gh pr comment "$PR_NUMBER" --repo "$REPO" --body "$BODY"

fi