FilesExpand file tree

main

/

repo-sync.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

194 lines (174 loc) · 7.63 KB

main

/

repo-sync.yml

Copy path

Top

File metadata and controls

• Code
• Blame

194 lines (174 loc) · 7.63 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

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

name: Repo Sync

# Syncs main between github/docs and github/docs-internal so public docs stay current

# and sensitive work stays private. Mechanics: https://github.com/repo-sync/repo-sync#how-it-works

on:

workflow_dispatch:

schedule:

- cron: '20 14-23/3 * * 1-5'

permissions:

contents: write

pull-requests: write

jobs:

repo-sync:

if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'

name: Repo Sync

runs-on: ubuntu-latest

steps:

- name: Check out repo

uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

with:

persist-credentials: false

- name: Sync repo to branch

env:

SOURCE_REPO: https://${{ secrets.DOCS_BOT_PAT_REPO_SYNC }}@github.com/github/${{ github.repository == 'github/docs-internal' && 'docs' || 'docs-internal' }}.git

SOURCE_BRANCH: main

DESTINATION_BRANCH: repo-sync

GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_REPO_SYNC }}

run: |

set -euo pipefail

: "${GH_TOKEN:?DOCS_BOT_PAT_REPO_SYNC is empty}"

: "${SOURCE_REPO:?SOURCE_REPO is empty}"

: "${SOURCE_BRANCH:?SOURCE_BRANCH is empty}"

: "${DESTINATION_BRANCH:?DESTINATION_BRANCH is empty}"

git config --unset-all http."https://github.com/".extraheader || true

git remote remove tmp_upstream 2>/dev/null || true

trap 'git remote remove tmp_upstream 2>/dev/null || true' EXIT

git remote set-url origin "https://x-access-token:${GH_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"

git remote add tmp_upstream "${SOURCE_REPO}"

git fetch tmp_upstream --quiet

git push origin "refs/remotes/tmp_upstream/${SOURCE_BRANCH}:refs/heads/${DESTINATION_BRANCH}" --force

- name: Ship pull request

uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3

with:

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

result-encoding: string

script: |

const { owner, repo } = context.repo

const head = 'github:repo-sync'

const base = 'main'

async function closePullRequest(prNumber) {

console.log('Closing pull request', prNumber)

await github.rest.pulls.update({

owner,

repo,

pull_number: prNumber,

state: 'closed'

})

// Let close failures fail the workflow.

console.log('Closed pull request', prNumber)

}

console.log('Closing any existing pull requests')

const { data: existingPulls } = await github.rest.pulls.list({ owner, repo, head, base })

if (existingPulls.length) {

console.log('Found existing pull requests', existingPulls.map(pull => pull.number))

for (const pull of existingPulls) {

await closePullRequest(pull.number)

}

console.log('Closed existing pull requests')

}

try {

const { data } = await github.rest.repos.compareCommits({

owner,

repo,

head,

base,

})

const { files } = data

console.log(`File changes between ${head} and ${base}:`, files)

if (!files.length) {

console.log('No files changed, bailing')

return

}

} catch (err) {

console.error(`Unable to compute the files difference between ${head} and ${base}`, err.message)

}

console.log('Creating a new pull request')

const body = `

This is an automated pull request to sync changes between the public and private repos.

Our bot will merge this pull request automatically.

To preserve continuity across repos, _do not squash_ this pull request.

`

let pull, pull_number

try {

const response = await github.rest.pulls.create({

owner,

repo,

head,

base,

title: 'Repo sync',

body,

})

pull = response.data

pull_number = pull.number

console.log('Created pull request successfully', pull.html_url)

} catch (err) {

// Don't alert on "No commits" or on the "same head_sha" error from over 100 PRs with one head.

if (err.message?.includes('No commits') || err.message?.includes('same head_sha')) {

console.log(err.message)

return

}

throw err

}

console.log('Locking conversations to prevent spam')

try {

await github.rest.issues.lock({

...context.repo,

issue_number: pull_number,

lock_reason: 'spam'

})

console.log('Locked the pull request to prevent spam')

} catch (error) {

console.error('Failed to lock the pull request.', error)

// Lock failures must not fail the sync.

}

console.log('Counting files changed')

const { data: prFiles } = await github.rest.pulls.listFiles({ owner, repo, pull_number })

if (prFiles.length) {

console.log(prFiles.length, 'files have changed')

} else {

console.log('No files changed, closing')

await closePullRequest(pull_number)

return

}

console.log('Checking for merge conflicts')

if (pull.mergeable_state === 'dirty') {

console.log('Pull request has a conflict', pull.html_url)

await closePullRequest(pull_number)

throw new Error('Pull request has a conflict, please resolve manually')

}

console.log('No detected merge conflicts')

console.log('Merging the pull request')

// merge_method: merge keeps merge commits; retry each minute for up to 15 minutes for checks.

const maxAttempts = 15

const delay = 60_000

for (let attempt = 1; attempt <= maxAttempts; attempt++) {

try {

await github.rest.pulls.merge({

owner,

repo,

pull_number,

merge_method: 'merge',

})

console.log('Merged the pull request successfully')

break

} catch (mergeError) {

const msg = mergeError.message || mergeError.response?.data?.message || ''

const isRuleViolation = mergeError.status === 405 &&

msg.includes('Repository rule violations')

if (!isRuleViolation || attempt === maxAttempts) {

throw mergeError

}

console.log(`Merge blocked by required checks (attempt ${attempt}/${maxAttempts}), retrying in 60s...`)

await new Promise(resolve => setTimeout(resolve, delay))

}

}

- uses: ./.github/actions/create-workflow-failure-issue

id: create-failure-issue

if: ${{ failure() && github.event_name != 'workflow_dispatch' }}

with:

token: ${{ secrets.DOCS_BOT_PAT_BASE }}

- uses: ./.github/actions/slack-alert

if: ${{ failure() && github.event_name != 'workflow_dispatch' }}

with:

slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}

issue_url: ${{ steps.create-failure-issue.outputs.issue_url }}