FilesExpand file tree

 main

/

_docs.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

191 lines (176 loc) · 7.59 KB

 main

/

_docs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

191 lines (176 loc) · 7.59 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

name: build docs

on:

workflow_call:

inputs:

build-environment:

required: true

type: string

description: Top-level label for what's being built/tested.

docker-image:

required: true

type: string

description: Docker image to run in.

push:

required: false

type: boolean

default: false

description: If set, push the docs to the docs website.

run-doxygen:

required: false

type: boolean

default: false

description: If set, will enable C++ API doc generation using doxygen / breathe / exhale.

sync-tag:

required: false

type: string

default: ""

description: |

If this is set, our linter will use this to make sure that every other

job with the same `sync-tag` is identical.

secrets:

GH_PYTORCHBOT_TOKEN:

required: false

description: Permissions for pushing to the docs site.

jobs:

build-docs:

# Don't run on forked repos.

if: github.repository_owner == 'pytorch'

runs-on: ${{ matrix.runner }}

environment: ${{ (github.ref == 'refs/heads/main' || startsWith(github.event.ref, 'refs/tags/v')) && 'pytorchbot-env' || '' }}

strategy:

fail-fast: false

matrix:

include:

- docs_type: cpp

# We recently seeing lots of exit code 137 running this in Docker indicating

# an OOM issue when running the job, so this upgrades the runner from 4xlarge

# to the next available tier of 12xlarge. So much memory just to generate cpp

# doc

runner: linux.12xlarge

# TODO: Nightly cpp docs take longer and longer to finish (more than 3h now)

# Let's try to figure out how this can be improved

timeout-minutes: 240

- docs_type: python

runner: linux.2xlarge

# It takes less than 30m to finish python docs unless there are issues

timeout-minutes: 30

- docs_type: functorch

runner: linux.2xlarge

# It takes less than 15m to finish functorch docs unless there are issues

timeout-minutes: 15

# Set a fixed name for this job instead of using the current matrix-generated name, i.e. build-docs (cpp, linux.12xlarge, 180)

# The current name requires updating the Rockset last docs push query from test-infra every time the matrix is updated

name: build-docs-${{ matrix.docs_type }}-${{ inputs.push }}

steps:

- name: Setup SSH (Click me for login details)

uses: pytorch/test-infra/.github/actions/setup-ssh@main

with:

github-secret: ${{ secrets.GITHUB_TOKEN }}

instructions: |

All builds are done inside the container, to start an interactive session run:

docker exec -it $(docker container ps --format '{{.ID}}') bash

To start Python docs build type:

cd docs && make html && make coverage

# [see note: pytorch repo ref]

- name: Checkout PyTorch

uses: pytorch/pytorch/.github/actions/checkout-pytorch@main

- name: Setup Linux

uses: ./.github/actions/setup-linux

- name: Calculate docker image

id: calculate-docker-image

uses: pytorch/test-infra/.github/actions/calculate-docker-image@main

with:

docker-image-name: ${{ inputs.docker-image }}

- name: Pull docker image

uses: pytorch/test-infra/.github/actions/pull-docker-image@main

with:

docker-image: ${{ steps.calculate-docker-image.outputs.docker-image }}

- name: Download build artifacts

uses: ./.github/actions/download-build-artifacts

with:

name: ${{ inputs.build-environment }}

- name: Generate netrc (only for docs-push)

if: inputs.push

env:

GITHUB_PYTORCHBOT_TOKEN: ${{ secrets.GH_PYTORCHBOT_TOKEN }}

run: |

# sometimes .netrc exists as a directory even though this is the temp folder

rm -rf "${RUNNER_TEMP}/.netrc"

# set credentials for https pushing

echo "machine github.com" > "${RUNNER_TEMP}/.netrc"

echo "login pytorchbot" >> "${RUNNER_TEMP}/.netrc"

echo "password ${GITHUB_PYTORCHBOT_TOKEN}" >> "${RUNNER_TEMP}/.netrc"

- name: Build ${{ matrix.docs_type }} docs

timeout-minutes: ${{ matrix.timeout-minutes }}

id: build-docs

env:

# After https://github.com/pytorch/pytorch/pull/88373, pull workflow can now be run periodically,

# so using a schedule event to determine if the docs should be pushed or not doesn't hold true

# anymore

WITH_PUSH: ${{ inputs.push }}

DOCKER_IMAGE: ${{ inputs.docker-image }}

DOCS_TYPE: ${{ matrix.docs_type }}

RUN_DOXYGEN: ${{ inputs.run-doxygen }}

BUILD_ENVIRONMENT: ${{ inputs.build-environment }}

run: |

set -ex

# Convert refs/tags/v1.12.0rc3 into 1.12

if [[ "${GITHUB_REF}" =~ ^refs/tags/v([0-9]+\.[0-9]+)\.* ]]; then

target="${BASH_REMATCH[1]}"

else

target="main"

fi

# detached container should get cleaned up by teardown_ec2_linux

container_name=$(docker run \

-e BUILD_ENVIRONMENT \

-e MAX_JOBS="$(nproc --ignore=2)" \

-e SHA1="$GITHUB_SHA" \

-e DOCS_VERSION="${target}" \

-e DOCS_TYPE \

-e RUN_DOXYGEN \

-e WITH_PUSH \

--env-file="/tmp/github_env_${GITHUB_RUN_ID}" \

--security-opt seccomp=unconfined \

--cap-add=SYS_PTRACE \

--tty \

--detach \

--user jenkins \

-v "${RUNNER_TEMP}/.netrc":/var/lib/jenkins/.netrc \

-v "${GITHUB_WORKSPACE}:/var/lib/jenkins/workspace" \

-w /var/lib/jenkins/workspace \

"${DOCKER_IMAGE}"

)

docker exec -t "${container_name}" bash -c "sudo chown -R jenkins . && pip install $(echo dist/*.whl)[opt-einsum] && ./.ci/pytorch/${DOCS_TYPE}_doc_push_script.sh"

- name: Chown workspace

uses: ./.github/actions/chown-workspace

if: always()

- name: Upload Python Docs Preview

uses: seemethere/upload-artifact-s3@v5

if: ${{ github.event_name == 'pull_request' && matrix.docs_type == 'python' && steps.build-docs.outcome == 'success' }}

with:

retention-days: 14

s3-bucket: doc-previews

if-no-files-found: error

path: pytorch.github.io/docs/main/

s3-prefix: pytorch/pytorch/${{ github.event.pull_request.number }}

- name: Upload C++ Docs Preview

uses: seemethere/upload-artifact-s3@v5

if: ${{ github.event_name == 'pull_request' && matrix.docs_type == 'cpp' && steps.build-docs.outcome == 'success' }}

with:

retention-days: 14

if-no-files-found: error

s3-bucket: doc-previews

path: cppdocs/

s3-prefix: pytorch/pytorch/${{ github.event.pull_request.number }}/cppdocs

- name: Upload functorch Docs Preview

uses: seemethere/upload-artifact-s3@v5

if: ${{ github.event_name == 'pull_request' && matrix.docs_type == 'functorch' && steps.build-docs.outcome == 'success' }}

with:

retention-days: 14

s3-bucket: doc-previews

if-no-files-found: error

path: functorch_ghpages/nightly/

s3-prefix: pytorch/pytorch/${{ github.event.pull_request.number }}/functorchdocs

- name: Teardown Linux

uses: pytorch/test-infra/.github/actions/teardown-linux@main

if: always()