Skip to content

Commit 4479fd6

Browse files
committed
Deploy internals documentation on prod and test environment
Resolves #8
1 parent 6ad8ae2 commit 4479fd6

File tree

4 files changed

+64
-11
lines changed

4 files changed

+64
-11
lines changed

.github/workflows/deloy-prod.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Deploy
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- master
8+
jobs:
9+
deploy:
10+
runs-on: ['self-hosted', 'Linux', 'flavor-8-16']
11+
container: tarantool/doc-builder:slim-4.2
12+
env:
13+
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
14+
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
15+
AWS_DEFAULT_REGION: ${{secrets.AWS_DEFAULT_REGION}}
16+
S3_ENDPOINT_URL: ${{secrets.S3_ENDPOINT_URL}}
17+
S3_UPLOAD_PATH: ${{secrets.S3_UPLOAD_PATH}}
18+
S3_BUCKET: ${{secrets.S3_BUCKET}}
19+
INTERNALS_UPDATE_URL: ${{secrets.INTERNALS_UPDATE_URL}}
20+
INTERNALS_UPDATE_KEY: ${{secrets.INTERNALS_UPDATE_KEY}}
21+
BRANCH_NAME: latest
22+
steps:
23+
- uses: actions/checkout@v2
24+
25+
- run: sphinx-build -b json source -d build/.doctrees build/json
26+
- run: bash upload_output.sh

.github/workflows/deploy-branch.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
name: Deploy-branch
2-
1+
name: Deploy branch
32
on:
43
pull_request:
54
jobs:
@@ -13,11 +12,11 @@ jobs:
1312
ENDPOINT_URL: ${{secrets.ENDPOINT_URL}}
1413
S3_UPLOAD_PATH: ${{secrets.S3_UPLOAD_PATH}}
1514
S3_BUCKET: ${{secrets.S3_BUCKET}}
15+
INTERNALS_UPDATE_URL: ${{secrets.INTERNALS_DEVELOP_UPDATE_URL}}
16+
INTERNALS_UPDATE_KEY: ${{secrets.INTERNALS_UPDATE_KEY}}
17+
BRANCH_NAME: test
1618
steps:
1719
- uses: actions/checkout@v2
1820

19-
- name: Set branch name from source branch
20-
run: echo "BRANCH_NAME=${GITHUB_HEAD_REF##*/}" >> $GITHUB_ENV
21-
2221
- run: sphinx-build -b json source -d build/.doctrees build/json
2322
- run: bash upload_output.sh

.github/workflows/deploy-dev.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Deploy-dev
2+
3+
on:
4+
pull_request:
5+
jobs:
6+
deploy-branch:
7+
runs-on: ['self-hosted', 'Linux', 'flavor-8-16']
8+
container: tarantool/doc-builder:slim-4.2
9+
env:
10+
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
11+
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
12+
AWS_DEFAULT_REGION: ${{secrets.AWS_DEFAULT_REGION}}
13+
ENDPOINT_URL: ${{secrets.ENDPOINT_URL}}
14+
S3_UPLOAD_PATH: ${{secrets.S3_UPLOAD_PATH}}
15+
S3_BUCKET: ${{secrets.S3_BUCKET}}
16+
INTERNALS_UPDATE_URL: ${{secrets.INTERNALS_DEVELOP_UPDATE_URL}}
17+
INTERNALS_UPDATE_KEY: ${{secrets.INTERNALS_UPDATE_KEY}}
18+
BRANCH_NAME: test
19+
steps:
20+
- uses: actions/checkout@v2
21+
22+
- run: sphinx-build -b json source -d build/.doctrees build/json
23+
- run: bash upload_output.sh

upload_output.sh

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
#!/usr/bin/env bash
22

3-
4-
BRANCH=$BRANCH_NAME
53
DOC_DEST="$S3_UPLOAD_PATH/internals/${BRANCH_NAME}"
6-
CHECK_KEY="doc-builds/internals/${BRANCH_NAME}/json/_build_ru/json/toctree.fjson"
4+
CHECK_KEY="doc-builds/internals/${BRANCH_NAME}/json/_build_en/json/toctree.fjson"
5+
UPDATE_KEY=$INTERNALS_UPDATE_KEY
6+
UPDATE_URL=$INTERNALS_UPDATE_URL
77

8-
aws s3api head-object --bucket ${S3_BUCKET} --key ${CHECK_KEY} --endpoint-url="$ENDPOINT_URL" || not_exist=true
8+
aws s3api head-object --bucket ${S3_BUCKET} --key ${CHECK_KEY} --endpoint-url="${ENDPOINT_URL}" || not_exist=true
99
if [ $not_exist ]; then
1010
echo "toctree.json does not exist"
1111
else
1212
echo "found toctree.json, remove the branch from s3 location"
13-
aws s3 rm "$DOC_DEST"/json --endpoint-url="$ENDPOINT_URL" --recursive
13+
aws s3 rm "${DOC_DEST}"/json --endpoint-url="${ENDPOINT_URL}" --recursive
1414
fi
1515

16-
aws s3 cp build/json "$DOC_DEST"/json --endpoint-url="$ENDPOINT_URL" --recursive --include "*" --exclude "*.jpg" --exclude "*.png" --exclude "*.svg"
16+
aws s3 cp build/json "${DOC_DEST}"/json/_build_en/json --endpoint-url="${ENDPOINT_URL}" --recursive --include "*" --exclude "*.jpg" --exclude "*.png" --exclude "*.svg"
17+
18+
curl --fail --show-error \
19+
--data '{"update_key":"'"${UPDATE_KEY}"'"}' \
20+
--header "Content-Type: application/json" \
21+
--request POST "${UPDATE_URL}""${BRANCH_NAME}"/

0 commit comments

Comments
 (0)