From d13c8c01bc29314afb90c87391552afc5bb559cf Mon Sep 17 00:00:00 2001 From: Will Cavanagh Date: Mon, 12 Jul 2021 09:40:47 -0700 Subject: [PATCH 1/9] Add broken link check to CI --- .github/workflows/generate-preview.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/generate-preview.yml b/.github/workflows/generate-preview.yml index 84eff410c..974bbead3 100644 --- a/.github/workflows/generate-preview.yml +++ b/.github/workflows/generate-preview.yml @@ -38,3 +38,8 @@ jobs: DOC_PATH: PR_NUMBER: ${{ github.event.number }} run: python ./tk-doc-generator/actions-generate-docs.py + - name: Check for broken links + uses: victoriadrake/link-snitch@v1.0.0 + env: + URL: http://sg-devdocs.s3-website-us-east-1.amazonaws.com/tk-doc-generator/${{ GITHUB_SHA }}/ + FILENAME: ./link_report.yaml From a008e8ba9486a6a0395a32671498ee12ebb9d73f Mon Sep 17 00:00:00 2001 From: Will Cavanagh Date: Mon, 12 Jul 2021 09:46:23 -0700 Subject: [PATCH 2/9] Fix named value accidentally populated with env var name --- .github/workflows/generate-preview.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/generate-preview.yml b/.github/workflows/generate-preview.yml index 974bbead3..9861af326 100644 --- a/.github/workflows/generate-preview.yml +++ b/.github/workflows/generate-preview.yml @@ -41,5 +41,5 @@ jobs: - name: Check for broken links uses: victoriadrake/link-snitch@v1.0.0 env: - URL: http://sg-devdocs.s3-website-us-east-1.amazonaws.com/tk-doc-generator/${{ GITHUB_SHA }}/ + URL: http://sg-devdocs.s3-website-us-east-1.amazonaws.com/tk-doc-generator/${{ github.sha }}/ FILENAME: ./link_report.yaml From 2372ec64f481ee09865607799d1b5ad57d4f5fdd Mon Sep 17 00:00:00 2001 From: Will Cavanagh Date: Mon, 12 Jul 2021 10:12:27 -0700 Subject: [PATCH 3/9] Add artifact upload and temporarily disable rebuild for testing purposes --- .github/workflows/generate-preview.yml | 31 +++++++++++++++++--------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/.github/workflows/generate-preview.yml b/.github/workflows/generate-preview.yml index 9861af326..7adf31228 100644 --- a/.github/workflows/generate-preview.yml +++ b/.github/workflows/generate-preview.yml @@ -27,19 +27,28 @@ jobs: run: bundle install --gemfile=./tk-doc-generator/Gemfile --deployment - name: Install tk-doc-generator requirements run: pip install -r ./tk-doc-generator/requirements.txt - - name: Generate and publish preview - env: - AWS_S3_ACCESS_KEY: ${{ secrets.AWS_S3_ACCESS_KEY }} - AWS_S3_ACCESS_TOKEN: ${{ secrets.AWS_S3_ACCESS_TOKEN }} - TK_GITHUB_TOKEN: ${{ secrets.TK_GITHUB_TOKEN }} - S3_BUCKET: sg-devdocs - S3_WEB_URL: http://sg-devdocs.s3-website-us-east-1.amazonaws.com - DOC_URL: https://developer.shotgridsoftware.com - DOC_PATH: - PR_NUMBER: ${{ github.event.number }} - run: python ./tk-doc-generator/actions-generate-docs.py + + # TODO re-enable! + # Temp disable this since it's been generated once and we're not + # interested in this step + # - name: Generate and publish preview + # env: + # AWS_S3_ACCESS_KEY: ${{ secrets.AWS_S3_ACCESS_KEY }} + # AWS_S3_ACCESS_TOKEN: ${{ secrets.AWS_S3_ACCESS_TOKEN }} + # TK_GITHUB_TOKEN: ${{ secrets.TK_GITHUB_TOKEN }} + # S3_BUCKET: sg-devdocs + # S3_WEB_URL: http://sg-devdocs.s3-website-us-east-1.amazonaws.com + # DOC_URL: https://developer.shotgridsoftware.com + # DOC_PATH: + # PR_NUMBER: ${{ github.event.number }} + # run: python ./tk-doc-generator/actions-generate-docs.py + - name: Check for broken links uses: victoriadrake/link-snitch@v1.0.0 env: URL: http://sg-devdocs.s3-website-us-east-1.amazonaws.com/tk-doc-generator/${{ github.sha }}/ FILENAME: ./link_report.yaml + - uses: actions/upload-artifact@v2 + with: + name: link-report + path: ./link_report.yaml From bf93a8cd92ca2a23e101ad7b47dc84e1cbccd872 Mon Sep 17 00:00:00 2001 From: Will Cavanagh Date: Mon, 12 Jul 2021 10:14:28 -0700 Subject: [PATCH 4/9] Disable even more of CI for testing... --- .github/workflows/generate-preview.yml | 34 +++++++++++++------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/workflows/generate-preview.yml b/.github/workflows/generate-preview.yml index 7adf31228..ab8d2f470 100644 --- a/.github/workflows/generate-preview.yml +++ b/.github/workflows/generate-preview.yml @@ -12,25 +12,25 @@ jobs: runs-on: ubuntu-latest environment: docs-build steps: - - name: Checkout repo and submodules - uses: actions/checkout@v2 - with: - # we need to checkout tk-doc-generator submodule as well. - submodules: 'true' - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: 2.6 - - name: Install Pandoc - run: sudo apt-get install -y pandoc - - name: Install Jekyll dependencies - run: bundle install --gemfile=./tk-doc-generator/Gemfile --deployment - - name: Install tk-doc-generator requirements - run: pip install -r ./tk-doc-generator/requirements.txt - # TODO re-enable! # Temp disable this since it's been generated once and we're not - # interested in this step + # interested in the work associated with regenerating -- we can test off + # the hosted site for now. + # - name: Checkout repo and submodules + # uses: actions/checkout@v2 + # with: + # # we need to checkout tk-doc-generator submodule as well. + # submodules: 'true' + # - name: Setup Ruby + # uses: ruby/setup-ruby@v1 + # with: + # ruby-version: 2.6 + # - name: Install Pandoc + # run: sudo apt-get install -y pandoc + # - name: Install Jekyll dependencies + # run: bundle install --gemfile=./tk-doc-generator/Gemfile --deployment + # - name: Install tk-doc-generator requirements + # run: pip install -r ./tk-doc-generator/requirements.txt # - name: Generate and publish preview # env: # AWS_S3_ACCESS_KEY: ${{ secrets.AWS_S3_ACCESS_KEY }} From 74fbc23dfecc99a49b25ec70da918af817292c09 Mon Sep 17 00:00:00 2001 From: Will Cavanagh Date: Mon, 12 Jul 2021 10:34:26 -0700 Subject: [PATCH 5/9] Try a different link checker --- .github/workflows/generate-preview.yml | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/.github/workflows/generate-preview.yml b/.github/workflows/generate-preview.yml index ab8d2f470..47c1b0933 100644 --- a/.github/workflows/generate-preview.yml +++ b/.github/workflows/generate-preview.yml @@ -44,11 +44,6 @@ jobs: # run: python ./tk-doc-generator/actions-generate-docs.py - name: Check for broken links - uses: victoriadrake/link-snitch@v1.0.0 - env: - URL: http://sg-devdocs.s3-website-us-east-1.amazonaws.com/tk-doc-generator/${{ github.sha }}/ - FILENAME: ./link_report.yaml - - uses: actions/upload-artifact@v2 + uses: filiph/linkcheck@v2.0.15+1 with: - name: link-report - path: ./link_report.yaml + arguments: http://sg-devdocs.s3-website-us-east-1.amazonaws.com/tk-doc-generator/${{ github.sha }}/ From 0d9fc8fb0f4b71eb9d120e35f76294546829b081 Mon Sep 17 00:00:00 2001 From: Will Cavanagh Date: Mon, 12 Jul 2021 10:41:42 -0700 Subject: [PATCH 6/9] Force specific hash, temporarily --- .github/workflows/generate-preview.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/generate-preview.yml b/.github/workflows/generate-preview.yml index 47c1b0933..0742bff49 100644 --- a/.github/workflows/generate-preview.yml +++ b/.github/workflows/generate-preview.yml @@ -46,4 +46,4 @@ jobs: - name: Check for broken links uses: filiph/linkcheck@v2.0.15+1 with: - arguments: http://sg-devdocs.s3-website-us-east-1.amazonaws.com/tk-doc-generator/${{ github.sha }}/ + arguments: http://sg-devdocs.s3-website-us-east-1.amazonaws.com/tk-doc-generator/fac5c220b799ca61e5e504c9532aa5bab645f8be/ From a6f4d9e2880bb5636525a88d927f7898334055ba Mon Sep 17 00:00:00 2001 From: Will Cavanagh Date: Mon, 12 Jul 2021 10:55:40 -0700 Subject: [PATCH 7/9] Try adding linting --- .github/workflows/generate-preview.yml | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/.github/workflows/generate-preview.yml b/.github/workflows/generate-preview.yml index 0742bff49..f753b306e 100644 --- a/.github/workflows/generate-preview.yml +++ b/.github/workflows/generate-preview.yml @@ -12,15 +12,19 @@ jobs: runs-on: ubuntu-latest environment: docs-build steps: + - name: Checkout repo and submodules + uses: actions/checkout@v2 + with: + # we need to checkout tk-doc-generator submodule as well. + submodules: 'true' + - name: Lint markdown + uses: avto-dev/markdown-lint@v1.5.0 + with: + args: './docs/**/*.md' # TODO re-enable! # Temp disable this since it's been generated once and we're not # interested in the work associated with regenerating -- we can test off # the hosted site for now. - # - name: Checkout repo and submodules - # uses: actions/checkout@v2 - # with: - # # we need to checkout tk-doc-generator submodule as well. - # submodules: 'true' # - name: Setup Ruby # uses: ruby/setup-ruby@v1 # with: From dbe7adc049c8aec02e8daedf0c0f27516f6d0887 Mon Sep 17 00:00:00 2001 From: Will Cavanagh Date: Tue, 13 Jul 2021 09:50:09 -0700 Subject: [PATCH 8/9] Re-enable build in CI --- .github/workflows/generate-preview.yml | 54 +++++++++++++------------- 1 file changed, 28 insertions(+), 26 deletions(-) diff --git a/.github/workflows/generate-preview.yml b/.github/workflows/generate-preview.yml index f753b306e..2ec7bba33 100644 --- a/.github/workflows/generate-preview.yml +++ b/.github/workflows/generate-preview.yml @@ -21,33 +21,35 @@ jobs: uses: avto-dev/markdown-lint@v1.5.0 with: args: './docs/**/*.md' - # TODO re-enable! - # Temp disable this since it's been generated once and we're not - # interested in the work associated with regenerating -- we can test off - # the hosted site for now. - # - name: Setup Ruby - # uses: ruby/setup-ruby@v1 - # with: - # ruby-version: 2.6 - # - name: Install Pandoc - # run: sudo apt-get install -y pandoc - # - name: Install Jekyll dependencies - # run: bundle install --gemfile=./tk-doc-generator/Gemfile --deployment - # - name: Install tk-doc-generator requirements - # run: pip install -r ./tk-doc-generator/requirements.txt - # - name: Generate and publish preview - # env: - # AWS_S3_ACCESS_KEY: ${{ secrets.AWS_S3_ACCESS_KEY }} - # AWS_S3_ACCESS_TOKEN: ${{ secrets.AWS_S3_ACCESS_TOKEN }} - # TK_GITHUB_TOKEN: ${{ secrets.TK_GITHUB_TOKEN }} - # S3_BUCKET: sg-devdocs - # S3_WEB_URL: http://sg-devdocs.s3-website-us-east-1.amazonaws.com - # DOC_URL: https://developer.shotgridsoftware.com - # DOC_PATH: - # PR_NUMBER: ${{ github.event.number }} - # run: python ./tk-doc-generator/actions-generate-docs.py + + # TODO: REMOVE + continue-on-error: true + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: 2.6 + - name: Install Pandoc + run: sudo apt-get install -y pandoc + - name: Install Jekyll dependencies + run: bundle install --gemfile=./tk-doc-generator/Gemfile --deployment + - name: Install tk-doc-generator requirements + run: pip install -r ./tk-doc-generator/requirements.txt + - name: Generate and publish preview + env: + AWS_S3_ACCESS_KEY: ${{ secrets.AWS_S3_ACCESS_KEY }} + AWS_S3_ACCESS_TOKEN: ${{ secrets.AWS_S3_ACCESS_TOKEN }} + TK_GITHUB_TOKEN: ${{ secrets.TK_GITHUB_TOKEN }} + S3_BUCKET: sg-devdocs + S3_WEB_URL: http://sg-devdocs.s3-website-us-east-1.amazonaws.com + DOC_URL: https://developer.shotgridsoftware.com + DOC_PATH: + PR_NUMBER: ${{ github.event.number }} + run: python ./tk-doc-generator/actions-generate-docs.py - name: Check for broken links uses: filiph/linkcheck@v2.0.15+1 with: - arguments: http://sg-devdocs.s3-website-us-east-1.amazonaws.com/tk-doc-generator/fac5c220b799ca61e5e504c9532aa5bab645f8be/ + arguments: http://sg-devdocs.s3-website-us-east-1.amazonaws.com/tk-doc-generator/${{ github.sha }}/ + + # TODO: REMOVE + continue-on-error: true From d2f0e76330971923722e02ec382c65e27e1ccd18 Mon Sep 17 00:00:00 2001 From: Will Cavanagh Date: Tue, 13 Jul 2021 09:50:31 -0700 Subject: [PATCH 9/9] Add quotes on problem page title in case front-matter formatting is breaking --- .../trusted-solutions/tier1/setup/media_segregation_s3_proxy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/trusted-solutions/tier1/setup/media_segregation_s3_proxy.md b/docs/en/trusted-solutions/tier1/setup/media_segregation_s3_proxy.md index 3de278e64..700a5ccf8 100644 --- a/docs/en/trusted-solutions/tier1/setup/media_segregation_s3_proxy.md +++ b/docs/en/trusted-solutions/tier1/setup/media_segregation_s3_proxy.md @@ -1,6 +1,6 @@ --- layout: default -title: Media Traffic Isolation - S3 Proxy +title: "Media Traffic Isolation - S3 Proxy" pagename: tier1-setup-media_segregation_s3_proxy lang: en ---