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

docs: Enables Docusaurus versioning for previous version of ICS docs #1442

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions docs/build.sh
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
#!/bin/sh

# This builds docs using docusaurus.
COMMIT=$(git rev-parse HEAD)
echo "building docusaurus main docs"
(git clean -fdx && git reset --hard && git checkout $COMMIT)
npm ci && npm run build
mv build ~/output
echo "done building docusaurus main docs"
# echo $DOCS_DOMAIN > ~/output/CNAME
for version in $(jq -r .[] versions.json); do
echo "Building docusaurus $version docs ..."
git checkout $version
npm cache clean --force && npm install && npm run docusaurus docs:version $version

# versions.json / package-lock.json, get mangled by Docusarus causing problems
rm versions.json package-lock.json
done

# Rebuild main/commit level docs
echo "Building docusaurus main docs ..."

rm package-lock.json
git checkout $COMMIT

# Move figures over
cp -R figures ./versioned_docs/

# Actual build
npm install && npm run build

echo "Finished building docs ... "
2 changes: 1 addition & 1 deletion docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ const config = {
{
type: "docsVersionDropdown",
position: "left",
dropdownActiveClassDisabled: true,
dropdownActiveClassDisabled: false,
},
],
},
Expand Down
5 changes: 5 additions & 0 deletions docs/versions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[
"v3.1.0",
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add a reminder to add new releases here to https://github.com/cosmos/interchain-security/blob/main/RELEASE_PROCESS.md?

"v2.2.0-provider-lsm",
"v2.1.0-provider-lsm"
]
Loading