From db219301d220276bbb04e3ddc38fbbb742c25e5d Mon Sep 17 00:00:00 2001 From: Simon Thulbourn Date: Tue, 20 Jun 2023 17:01:21 +0200 Subject: [PATCH 1/8] fix(docs): aliases in versions.json --- .github/workflows/reusable-publish-docs.yml | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/.github/workflows/reusable-publish-docs.yml b/.github/workflows/reusable-publish-docs.yml index be135d2443..4653fc07df 100644 --- a/.github/workflows/reusable-publish-docs.yml +++ b/.github/workflows/reusable-publish-docs.yml @@ -134,7 +134,20 @@ jobs: aws s3 cp \ s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json \ versions_old.json + - name: Deploy Docs (Version) + env: + VERSION: ${{ inputs.version }} + ALIAS: ${{ inputs.alias }} + run: | + aws s3 cp \ + s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-python/versions.json \ + versions_old.json + jq 'del(.[].aliases[] | select(. == "stage"))' < versions_old.json > versions_proc.json + jq '. += [{"version": "${{ env.VERSION }}", "title": "${{ env.VERSION }}", "aliases": ["latest"]}]' < versions_proc.json > versions.json + aws s3 cp \ + versions.json \ + s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-python/versions.json jq '. += [{"version": "${{ env.VERSION }}", "title": "${{ env.VERSION }}", "aliases": []}]' < versions_old.json > versions.json aws s3 cp \ versions.json \ - s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json \ No newline at end of file + s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json From cc5a561b008a8d3cd4ca164e98f2cc0dfad628dc Mon Sep 17 00:00:00 2001 From: Simon Thulbourn Date: Tue, 20 Jun 2023 17:05:49 +0200 Subject: [PATCH 2/8] fix alignment --- .github/workflows/reusable-publish-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/reusable-publish-docs.yml b/.github/workflows/reusable-publish-docs.yml index 4653fc07df..3f19e1be36 100644 --- a/.github/workflows/reusable-publish-docs.yml +++ b/.github/workflows/reusable-publish-docs.yml @@ -134,7 +134,7 @@ jobs: aws s3 cp \ s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json \ versions_old.json - - name: Deploy Docs (Version) + - name: Deploy Docs (Version) env: VERSION: ${{ inputs.version }} ALIAS: ${{ inputs.alias }} From 749ae0bec5d26a085053bca1bd1e5135a371c299 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Tue, 20 Jun 2023 17:11:57 +0200 Subject: [PATCH 3/8] Update .github/workflows/reusable-publish-docs.yml --- .github/workflows/reusable-publish-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/reusable-publish-docs.yml b/.github/workflows/reusable-publish-docs.yml index 3f19e1be36..83b5550054 100644 --- a/.github/workflows/reusable-publish-docs.yml +++ b/.github/workflows/reusable-publish-docs.yml @@ -146,7 +146,7 @@ jobs: jq '. += [{"version": "${{ env.VERSION }}", "title": "${{ env.VERSION }}", "aliases": ["latest"]}]' < versions_proc.json > versions.json aws s3 cp \ versions.json \ - s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-python/versions.json + s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json jq '. += [{"version": "${{ env.VERSION }}", "title": "${{ env.VERSION }}", "aliases": []}]' < versions_old.json > versions.json aws s3 cp \ versions.json \ From c93c562269dce9f53a68c6c694530d73a4fbc292 Mon Sep 17 00:00:00 2001 From: Simon Thulbourn Date: Tue, 20 Jun 2023 17:18:19 +0200 Subject: [PATCH 4/8] Update reusable-publish-docs.yml --- .github/workflows/reusable-publish-docs.yml | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/workflows/reusable-publish-docs.yml b/.github/workflows/reusable-publish-docs.yml index 83b5550054..8aea7b93b4 100644 --- a/.github/workflows/reusable-publish-docs.yml +++ b/.github/workflows/reusable-publish-docs.yml @@ -138,12 +138,20 @@ jobs: env: VERSION: ${{ inputs.version }} ALIAS: ${{ inputs.alias }} + # We originally used "mike" from PyPi to manage versions for us, but since we moved to S3, we can't use it to manage versions any more. + # Instead, we're using some shell script that manages the versions. + # + # Operations: + # 1. Download the versions.json file from S3 + # 2. Find any reference to the alias and delete it from the versions file + # 3. We insert the new version to the versions.json file with the corresponding alias + # 4. Once done, we'll upload it back to S3. run: | aws s3 cp \ s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-python/versions.json \ versions_old.json - jq 'del(.[].aliases[] | select(. == "stage"))' < versions_old.json > versions_proc.json - jq '. += [{"version": "${{ env.VERSION }}", "title": "${{ env.VERSION }}", "aliases": ["latest"]}]' < versions_proc.json > versions.json + jq 'del(.[].aliases[] | select(. == "${{ env.ALIAS }}"))' < versions_old.json > versions_proc.json + jq '. += [{"version": "${{ env.VERSION }}", "title": "${{ env.VERSION }}", "aliases": ["${{ env.ALIAS }}"]}]' < versions_proc.json > versions.json aws s3 cp \ versions.json \ s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json From d1ad506938fabf9064ee4b47e49341c9d3b2442d Mon Sep 17 00:00:00 2001 From: Simon Thulbourn Date: Tue, 20 Jun 2023 17:21:36 +0200 Subject: [PATCH 5/8] change stanza name --- .github/workflows/reusable-publish-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/reusable-publish-docs.yml b/.github/workflows/reusable-publish-docs.yml index 8aea7b93b4..d53813bf24 100644 --- a/.github/workflows/reusable-publish-docs.yml +++ b/.github/workflows/reusable-publish-docs.yml @@ -134,7 +134,7 @@ jobs: aws s3 cp \ s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json \ versions_old.json - - name: Deploy Docs (Version) + - name: Deploy Docs (Version JSON) env: VERSION: ${{ inputs.version }} ALIAS: ${{ inputs.alias }} From 9452f424ee11a2c671f738623b16a249f09b2067 Mon Sep 17 00:00:00 2001 From: Simon Thulbourn Date: Tue, 20 Jun 2023 17:25:48 +0200 Subject: [PATCH 6/8] remove dupe code --- .github/workflows/reusable-publish-docs.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/workflows/reusable-publish-docs.yml b/.github/workflows/reusable-publish-docs.yml index d53813bf24..2a2b763ba1 100644 --- a/.github/workflows/reusable-publish-docs.yml +++ b/.github/workflows/reusable-publish-docs.yml @@ -155,7 +155,3 @@ jobs: aws s3 cp \ versions.json \ s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json - jq '. += [{"version": "${{ env.VERSION }}", "title": "${{ env.VERSION }}", "aliases": []}]' < versions_old.json > versions.json - aws s3 cp \ - versions.json \ - s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json From 2c06c16aefcd2e588a2f195670562f7368bd50a6 Mon Sep 17 00:00:00 2001 From: Simon Thulbourn Date: Tue, 20 Jun 2023 17:26:37 +0200 Subject: [PATCH 7/8] remove dupe code --- .github/workflows/reusable-publish-docs.yml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/.github/workflows/reusable-publish-docs.yml b/.github/workflows/reusable-publish-docs.yml index 2a2b763ba1..60acfcad94 100644 --- a/.github/workflows/reusable-publish-docs.yml +++ b/.github/workflows/reusable-publish-docs.yml @@ -126,14 +126,6 @@ jobs: aws s3 sync \ site/ \ s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/${{ env.ALIAS }}/ - - name: Deploy Docs (Version JSON) - env: - VERSION: ${{ inputs.version }} - ALIAS: ${{ inputs.alias }} - run: | - aws s3 cp \ - s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json \ - versions_old.json - name: Deploy Docs (Version JSON) env: VERSION: ${{ inputs.version }} From 596efcf6cedfc54208c2f31e4979bfa82f2ab8ad Mon Sep 17 00:00:00 2001 From: Simon Thulbourn Date: Wed, 21 Jun 2023 15:36:57 +0200 Subject: [PATCH 8/8] Update reusable-publish-docs.yml --- .github/workflows/reusable-publish-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/reusable-publish-docs.yml b/.github/workflows/reusable-publish-docs.yml index 60acfcad94..47e70910fd 100644 --- a/.github/workflows/reusable-publish-docs.yml +++ b/.github/workflows/reusable-publish-docs.yml @@ -140,7 +140,7 @@ jobs: # 4. Once done, we'll upload it back to S3. run: | aws s3 cp \ - s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-python/versions.json \ + s3://${{ secrets.AWS_DOCS_BUCKET }}/lambda-typescript/versions.json \ versions_old.json jq 'del(.[].aliases[] | select(. == "${{ env.ALIAS }}"))' < versions_old.json > versions_proc.json jq '. += [{"version": "${{ env.VERSION }}", "title": "${{ env.VERSION }}", "aliases": ["${{ env.ALIAS }}"]}]' < versions_proc.json > versions.json