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

fix: update archival scripts #3759

Merged
merged 1 commit into from
May 6, 2024

Conversation

pepopowitz
Copy link
Collaborator

@pepopowitz pepopowitz commented May 2, 2024

Description

Updates the scripts for archiving versions, to fix a couple things that were being dropped during the archival.

Also updates the versions in the archival script, which is unnecessary, but is also a good hint for the next time we archive.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@pepopowitz pepopowitz added kind/bug Issues related with bugs in the documentation dx Documentation infrastructure typically handled by the Camunda DX team labels May 2, 2024
@pepopowitz pepopowitz requested a review from akeller May 2, 2024 16:26
@pepopowitz pepopowitz self-assigned this May 2, 2024
Comment on lines -3 to -4
# 1. build-docs: remove everything after the line `NODE_OPTIONS: --max_old_space_size=4096`.
sed -i '' '/NODE_OPTIONS: --max_old_space_size=4096/q' .github/workflows/build-docs.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.

This broke because I updated the heap size in build-docs.yaml recently. Here I've removed the heap size number entirely, in case we need to bump again in the future.

@@ -32,5 +32,5 @@ sed -i '' "s/optimize\/$ARCHIVED_OPTIMIZE_VERSION\//optimize\//g" versioned_side
# remove hard-coded versions from optimize docs sidebar configuration
sed -i '' "s/docs\/$ARCHIVED_VERSION\//docs\//g" optimize_versioned_sidebars/version-$ARCHIVED_OPTIMIZE_VERSION-sidebars.json

git add docusaurus.config.js src/mdx versioned_sidebars optimize_versioned_sidebars
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 noticed this in time to fix it in #3755, but this script was not including one of the changed files in the commit.

@pepopowitz pepopowitz merged commit 74d4590 into main May 6, 2024
10 checks passed
@pepopowitz pepopowitz deleted the pepopowitz/3731-81-archival/fix-automated-steps branch May 6, 2024 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dx Documentation infrastructure typically handled by the Camunda DX team kind/bug Issues related with bugs in the documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants