FilesExpand file tree

 main

/

github-app.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

144 lines (115 loc) · 5.22 KB

 main

/

github-app.ts

Copy path

Top

File metadata and controls

• Code
• Blame

144 lines (115 loc) · 5.22 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

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

export const PR_TITLE = 'Add Claude Code GitHub Workflow'

export const GITHUB_ACTION_SETUP_DOCS_URL =

'https://github.com/anthropics/claude-code-action/blob/main/docs/setup.md'

export const WORKFLOW_CONTENT = `name: Claude Code

on:

issue_comment:

types: [created]

pull_request_review_comment:

types: [created]

issues:

types: [opened, assigned]

pull_request_review:

types: [submitted]

jobs:

claude:

if: |

(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||

(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||

(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||

(github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))

runs-on: ubuntu-latest

permissions:

contents: read

pull-requests: read

issues: read

id-token: write

actions: read # Required for Claude to read CI results on PRs

steps:

- name: Checkout repository

uses: actions/checkout@v4

with:

fetch-depth: 1

- name: Run Claude Code

id: claude

uses: anthropics/claude-code-action@v1

with:

anthropic_api_key: \${{ secrets.ANTHROPIC_API_KEY }}

# This is an optional setting that allows Claude to read CI results on PRs

additional_permissions: |

actions: read

# Optional: Give a custom prompt to Claude. If this is not specified, Claude will perform the instructions specified in the comment that tagged it.

# prompt: 'Update the pull request description to include a summary of changes.'

# Optional: Add claude_args to customize behavior and configuration

# See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md

# or https://code.claude.com/docs/en/cli-reference for available options

# claude_args: '--allowed-tools Bash(gh pr:*)'

`

export const PR_BODY = `## 🤖 Installing Claude Code GitHub App

This PR adds a GitHub Actions workflow that enables Claude Code integration in our repository.

### What is Claude Code?

[Claude Code](https://claude.com/claude-code) is an AI coding agent that can help with:

- Bug fixes and improvements

- Documentation updates

- Implementing new features

- Code reviews and suggestions

- Writing tests

- And more!

### How it works

Once this PR is merged, we'll be able to interact with Claude by mentioning @claude in a pull request or issue comment.

Once the workflow is triggered, Claude will analyze the comment and surrounding context, and execute on the request in a GitHub action.

### Important Notes

- **This workflow won't take effect until this PR is merged**

- **@claude mentions won't work until after the merge is complete**

- The workflow runs automatically whenever Claude is mentioned in PR or issue comments

- Claude gets access to the entire PR or issue context including files, diffs, and previous comments

### Security

- Our Anthropic API key is securely stored as a GitHub Actions secret

- Only users with write access to the repository can trigger the workflow

- All Claude runs are stored in the GitHub Actions run history

- Claude's default tools are limited to reading/writing files and interacting with our repo by creating comments, branches, and commits.

- We can add more allowed tools by adding them to the workflow file like:

\`\`\`

allowed_tools: Bash(npm install),Bash(npm run build),Bash(npm run lint),Bash(npm run test)

\`\`\`

There's more information in the [Claude Code action repo](https://github.com/anthropics/claude-code-action).

After merging this PR, let's try mentioning @claude in a comment on any PR to get started!`

export const CODE_REVIEW_PLUGIN_WORKFLOW_CONTENT = `name: Claude Code Review

on:

pull_request:

types: [opened, synchronize, ready_for_review, reopened]

# Optional: Only run on specific file changes

# paths:

# - "src/**/*.ts"

# - "src/**/*.tsx"

# - "src/**/*.js"

# - "src/**/*.jsx"

jobs:

claude-review:

# Optional: Filter by PR author

# if: |

# github.event.pull_request.user.login == 'external-contributor' ||

# github.event.pull_request.user.login == 'new-developer' ||

# github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'

runs-on: ubuntu-latest

permissions:

contents: read

pull-requests: read

issues: read

id-token: write

steps:

- name: Checkout repository

uses: actions/checkout@v4

with:

fetch-depth: 1

- name: Run Claude Code Review

id: claude-review

uses: anthropics/claude-code-action@v1

with:

anthropic_api_key: \${{ secrets.ANTHROPIC_API_KEY }}

plugin_marketplaces: 'https://github.com/anthropics/claude-code.git'

plugins: 'code-review@claude-code-plugins'

prompt: '/code-review:code-review \${{ github.repository }}/pull/\${{ github.event.pull_request.number }}'

# See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md

# or https://code.claude.com/docs/en/cli-reference for available options

`