FilesExpand file tree

main

/

test.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

147 lines (130 loc) · 5.34 KB

main

/

test.yml

Copy path

Top

File metadata and controls

• Code
• Blame

147 lines (130 loc) · 5.34 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

name: Node.js Tests

# **What it does**: Runs our tests.

# **Why we have it**: We want our tests to pass before merging code.

# **Who does it impact**: Docs engineering, open-source engineering contributors.

on:

workflow_dispatch:

pull_request:

push:

branches:

- gh-readonly-queue/main/**

permissions:

contents: read

# Needed for the 'trilom/file-changes-action' action

pull-requests: read

# This allows a subsequently queued workflow run to interrupt previous runs

concurrency:

group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'

cancel-in-progress: true

jobs:

test:

# Run on ubuntu-20.04-xl if the private repo or ubuntu-latest if the public repo

# See pull # 17442 in the private repo for context

runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }}

timeout-minutes: 60

strategy:

fail-fast: false

matrix:

# The same array lives in test-windows.yml, so make any updates there too.

test-group:

[

content,

graphql,

meta,

rendering,

routing,

unit,

linting,

translations,

]

steps:

# Each of these ifs needs to be repeated at each step to make sure the required check still runs

# Even if if doesn't do anything

- name: Check out repo

uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748

with:

# Not all test suites need the LFS files. So instead, we opt to

# NOT clone them initially and instead, include them manually

# only for the test groups that we know need the files.

lfs: ${{ matrix.test-group == 'content' }}

# Enables cloning the Early Access repo later with the relevant PAT

persist-credentials: 'false'

- name: Figure out which docs-early-access branch to checkout, if internal repo

if: ${{ github.repository == 'github/docs-internal' }}

id: check-early-access

uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d

env:

BRANCH_NAME: ${{ github.head_ref || github.ref_name }}

with:

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

result-encoding: string

script: |

// If being run from a PR, this becomes 'my-cool-branch'.

// If run on main, with the `workflow_dispatch` action for

// example, the value becomes 'main'.

const { BRANCH_NAME } = process.env

try {

const response = await github.repos.getBranch({

owner: 'github',

repo: 'docs-early-access',

BRANCH_NAME,

})

console.log(`Using docs-early-access branch called '${BRANCH_NAME}'.`)

return BRANCH_NAME

} catch (err) {

if (err.status === 404) {

console.log(`There is no docs-early-access branch called '${BRANCH_NAME}' so checking out 'main' instead.`)

return 'main'

}

throw err

}

- name: Check out docs-early-access too, if internal repo

if: ${{ github.repository == 'github/docs-internal' }}

uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748

with:

repository: github/docs-early-access

token: ${{ secrets.DOCUBOT_REPO_PAT }}

path: docs-early-access

ref: ${{ steps.check-early-access.outputs.result }}

- name: Merge docs-early-access repo's folders

if: ${{ github.repository == 'github/docs-internal' }}

run: |

mv docs-early-access/assets assets/images/early-access

mv docs-early-access/content content/early-access

mv docs-early-access/data data/early-access

rm -r docs-early-access

# This is necessary when LFS files where cloned but does nothing

# if actions/checkout was run with `lfs:false`.

- name: Checkout LFS objects

run: git lfs checkout

- name: Gather files changed

uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b

id: get_diff_files

with:

# So that `steps.get_diff_files.outputs.files` becomes

# a string like `foo.js path/bar.md`

output: ' '

- name: Insight into changed files

run: |

# Must to do this because the list of files can be HUGE. Especially

# in a repo-sync when there are lots of translation files involved.

echo "${{ steps.get_diff_files.outputs.files }}" > get_diff_files.txt

- name: Setup node

uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048

with:

node-version: '16.15.0'

cache: npm

- name: Install dependencies

run: npm ci

- name: Cache nextjs build

uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09

with:

path: .next/cache

key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }}

- name: Run build script

run: npm run build

- name: Run tests

env:

DIFF_FILE: get_diff_files.txt

CHANGELOG_CACHE_FILE_PATH: tests/fixtures/changelog-feed.json

run: npm test -- tests/${{ matrix.test-group }}/