FilesExpand file tree

main

/

check-for-spammy-prs.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

97 lines (87 loc) · 3.91 KB

main

/

check-for-spammy-prs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

97 lines (87 loc) · 3.91 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

name: Check for Spammy PRs

# Flags low-value public PRs and closes PRs that target branches other than main.

on:

pull_request_target:

types: [opened, edited, reopened, synchronize]

permissions:

contents: read

pull-requests: write

jobs:

spammy-pr-check:

name: Label spammy PRs and reject non-main targets

if: >

github.repository == 'github/docs' && github.event_name == 'pull_request_target' &&

github.event.pull_request.user.login != 'docs-bot'

runs-on: ubuntu-latest

steps:

- uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3

with:

github-token: ${{ secrets.DOCS_BOT_PAT_BASE }}

script: |

const owner = 'github'

const repo = 'docs'

const pull_number = context.payload.pull_request.number

const targetsNonMain = context.payload.pull_request.base.ref !== 'main'

const files = await github.paginate(github.rest.pulls.listFiles, {

owner,

repo,

pull_number,

per_page: 100,

})

const onlyDeletes = files.length > 0 && files.every(f => f.status === 'removed')

const onlyDeletesLines =

files.some(file => file.deletions > 0) &&

files.every(file => file.additions === 0)

const isEmptyCommit = !files.length

const touchesTooMany = files.length > 10

const isBlankLineEdit = files.length > 0 && files.every(file => {

const changedLines = (file.patch || '')

.split('\n')

.filter(line => /^[+-]/.test(line))

return changedLines.length > 0 &&

changedLines.every(line => line.slice(1).trim() === '')

})

const onlyRenames = files.length > 0 && files.every(

f => f.status === 'renamed' && f.additions === 0 && f.deletions === 0

)

const onlyIndexMd = files.length === 1 && files[0].filename.split('/').pop() === 'index.md'

if (

targetsNonMain ||

onlyDeletesLines ||

onlyDeletes ||

isEmptyCommit ||

touchesTooMany ||

isBlankLineEdit ||

onlyRenames ||

onlyIndexMd

) {

await github.rest.issues.addLabels({

owner,

repo,

issue_number: pull_number,

labels: ['invalid'],

})

await github.rest.issues.createComment({

owner,

repo,

issue_number: pull_number,

body: targetsNonMain

? 'Pull requests must target the `main` branch. This pull request has been closed as invalid. If you think this is incorrect, please mention this in a corresponding issue.'

: onlyDeletesLines

? 'This pull request only removes existing content. Before submitting a content-removal pull request, please [open an issue](https://github.com/github/docs/issues/new/choose) explaining the proposed removal and wait for approval from the GitHub Docs team. Once the change has been approved, you can open a new pull request and link it to the issue.'

: "This pull request may have been opened accidentally. I'm going to close it now, but feel free to check out our [contribution guidelines](https://docs.github.com/en/contributing), or raise an issue.",

})

if (targetsNonMain) {

await github.rest.pulls.update({

owner,

repo,

pull_number,

state: 'closed',

})

}

if (onlyDeletesLines) {

core.setFailed(

'This pull request only deletes lines. An approved issue is required first.',

)

}

}