Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: archival of version 0.25, part 3: manual steps #2167

Merged
Changes from 22 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
ea8618a
archiving: delete version version-0.26
pepopowitz Jun 2, 2023
442d458
archiving: delete version version-1.0
pepopowitz Jun 2, 2023
30026c6
archiving: delete version version-1.1
pepopowitz Jun 2, 2023
2f6a4c7
archiving: delete version version-1.2
pepopowitz Jun 2, 2023
3c4019c
archiving: delete version version-1.3
pepopowitz Jun 2, 2023
fb1dbb8
archiving: delete version version-8.0
pepopowitz Jun 2, 2023
a9a5c2f
archiving: delete version version-8.1
pepopowitz Jun 2, 2023
00423cd
archiving: delete version version-8.2
pepopowitz Jun 2, 2023
a8b3adf
archiving: delete version version-8.2
pepopowitz Jun 2, 2023
587045a
archiving: exclude all other versions from the version file
pepopowitz Jun 2, 2023
d28b398
archiving: prevent unsupported site from being crawled
pepopowitz Jun 2, 2023
38ab421
archiving: fix Dockerfile for local debugging
pepopowitz Jun 2, 2023
8abd64f
archiving: update docusaurus config to build only 0.25
pepopowitz Jun 2, 2023
bfb4071
archiving: update theme components
pepopowitz Jun 2, 2023
caf1152
archiving(CI): remove link-checking from build-docs workflow
pepopowitz Jun 2, 2023
5a991ee
archiving(CI): remove link-check workflow
pepopowitz Jun 2, 2023
9eacbb9
archiving(links): update or remove broken links
pepopowitz Jun 2, 2023
9d35da5
archiving(ci): remove the rest of the link-checking from build docs b…
pepopowitz Jun 2, 2023
8b1b224
archiving(config): use an icon that stands out in announcement bar
pepopowitz Jun 2, 2023
ebc5bfd
archiving(ci): update publish workflows to push to the right place
pepopowitz Jun 2, 2023
a466c4e
archiving(ci): run publish workflows at the correct time
pepopowitz Jun 2, 2023
3daaf78
archiving(ci): fix trigger for prod publish
pepopowitz Jun 2, 2023
9f3cba2
archiving(htaccess): update rewrite rules based on URL structure of i…
pepopowitz Jun 5, 2023
3024f8e
Merge branch 'unsupported/0.25' into pepopowitz/1173-archiving/isolat…
pepopowitz Jun 5, 2023
cb854ab
archiving(oops): put the tags-ignore back in, to prevent staging depl…
pepopowitz Jun 5, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
29 changes: 0 additions & 29 deletions .github/workflows/build-docs.yaml
Original file line number Diff line number Diff line change
@@ -30,32 +30,3 @@ jobs:
run: npm run build
env:
NODE_OPTIONS: --max_old_space_size=4096
- name: Remove https redirect
run: |
sed -i '/SERVER_PORT/d;/SERVER_NAME/d' build/.htaccess
- name: Run web server
run: |
docker run -d --name webserver -v "$PWD/build":/app -p 8888:8080 bitnami/apache:2.4.54
echo "container_ip=$(docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' webserver)" >> $GITHUB_ENV
- name: Download sitemap from production
run: curl -sL https://docs.camunda.io/sitemap.xml | grep -oP '<loc>\K.*?(?=</loc>)' | sed "s!https://docs.camunda.io!http://${{ env.container_ip }}:8080!g" > sitemap.prod.txt
- name: Prepare product links
run: grep 'https://docs.camunda.io' product-links.txt | sed "s!https://docs.camunda.io!http://${{ env.container_ip }}:8080!g" > product-links.prod.txt
- name: Waiting for URL available
uses: nev7n/wait_for_response@v1
with:
url: "http://${{ env.container_ip }}:8080/"
- name: Validate sitemap links
uses: lycheeverse/lychee-action@v1.6.1
with:
args: "sitemap.prod.txt"
fail: true
- name: Validate product links
uses: lycheeverse/lychee-action@v1.6.1
with:
args: "product-links.prod.txt"
fail: true
- name: Check internal links
uses: untitaker/hyperlink@0.1.27
with:
args: build/
Comment on lines -58 to -61
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is potentially controversial. The sitemap & product link checks are definitely not something we want to run, because this is an isolated site containing only one old version. But the internal links of the app is probably still worth checking, if it's not much work.

Unfortunately it isn't "not much work"! I'd have to alter the steps above that run the webserver to run the app in a /0.25 folder, or else the internal link-checking would fail because of the baseURL of /0.25.

My feeling is that it's fine to remove this link-checking. It's an unsupported version of the docs, and if an internal link gets broken over time, I think we just say forget it.

But if you feel strongly that I should get this internal link-checking working, let me know!!!

28 changes: 0 additions & 28 deletions .github/workflows/linkcheck.yaml
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing this workflow entirely, as we won't want to run it against the 0.25 site.

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/publish-prod.yaml
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ name: publish-prod
on:
push:
tags:
- "[0-9]+.[0-9]+.[0-9]+"
- "0.25.[0-9]+"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is the right way to do this? Trigger a 0.25 production build only when we create a 0.25.X release.

🚨 We'll have to make sure we update main to exclude the archived tags before we publish a 0.25.x release! Otherwise I think main will trigger a new prod publish, and deploy the 0.25 site to docs.camunda.io!!! (I think that's what would happen?)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR to prevent accidental 0.25 deployment to docs.camunda.io is up, at #2172


permissions:
id-token: write
@@ -37,7 +37,7 @@ jobs:
with:
switches: -avzr --delete
path: build/
remote_path: ${{ secrets.AWS_PROD_PUBLISH_PATH }}
remote_path: ${{ secrets.AWS_PROD_PUBLISH_PATH_UNSUPPORTED }}/0.25
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've already added this new key to the project secrets (and to the Keeper record that contains these secrets).

remote_host: ${{ secrets.AWS_PROD_PUBLISH_HOST }}
remote_user: ${{ secrets.AWS_PROD_PUBLISH_USER }}
# vvvvv Intentionally missing the AWS_ prefix vvvvv
10 changes: 3 additions & 7 deletions .github/workflows/publish-stage.yaml
Original file line number Diff line number Diff line change
@@ -3,9 +3,7 @@ name: publish-stage
on:
push:
branches:
- "main"
tags-ignore:
- "*"
- "unsupported/0.25"
pepopowitz marked this conversation as resolved.
Show resolved Hide resolved

permissions:
id-token: write
@@ -20,10 +18,8 @@ jobs:
node-version: 16
- name: Install Dependencies
run: npm ci
- name: Disable Indexing
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indexing is already disabled in the config itself.

run: "sed -i 's/noIndex: false/noIndex: true/g' docusaurus.config.js"
- name: Update URL
run: 'sed -i ''s!url: "https://docs.camunda.io"!url: "https://stage.docs.camunda.io"!g'' docusaurus.config.js'
run: 'sed -i ''s!url: "https://unsupported.docs.camunda.io"!url: "https://stage.unsupported.docs.camunda.io"!g'' docusaurus.config.js'
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New URLs

- name: Build
run: npm run build
env:
@@ -43,7 +39,7 @@ jobs:
with:
switches: -avzr --delete
path: build/
remote_path: ${{ secrets.AWS_STAGE_PUBLISH_PATH }}
remote_path: ${{ secrets.AWS_STAGE_PUBLISH_PATH_UNSUPPORTED }}/0.25
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've already added this new key to the project secrets (and to the Keeper record that contains these secrets).

remote_host: ${{ secrets.AWS_STAGE_PUBLISH_HOST }}
remote_user: ${{ secrets.AWS_STAGE_PUBLISH_USER }}
# vvvvv Intentionally missing the AWS_ prefix vvvvv
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -3,12 +3,12 @@
FROM httpd:alpine

RUN rm -r /usr/local/apache2/htdocs/*
COPY /build /usr/local/apache2/htdocs/
COPY /build /usr/local/apache2/htdocs/0.25/

# Remove SSL requirement
RUN sed -i \
'/SERVER_PORT/d;/SERVER_NAME/d' \
/usr/local/apache2/htdocs/.htaccess
/usr/local/apache2/htdocs/0.25/.htaccess

# Enable the rewrite module
RUN sed -i \
127 changes: 0 additions & 127 deletions docs/apis-tools/build-your-own-client.md

This file was deleted.

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading