Skip to content

CSHARP-5799: Implement api-docs redirection page to the latest version #1833

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

CSHARP-5799: Implement api-docs redirection page to the latest version #1833

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50ec9d8
CSHARP-5799: Implement api-docs redirection page to the latest version
sanych-sun Nov 29, 2025
9918b3d
pr
sanych-sun Nov 29, 2025
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
28 changes: 26 additions & 2 deletions evergreen/upload-apidocs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,40 @@
#!/usr/bin/env bash
#!/usr/bin/env bash
set -o errexit # Exit the script with error if any of the commands fail

DOCS_REPO="https://${GITHUB_USER}:${GITHUB_APIKEY}@github.com/mongodb/mongo-csharp-driver.git"

echo "Prepare github docs"
echo "Cloning github repo..."
git clone "$DOCS_REPO" ./gh-pages/ --branch gh-pages --single-branch

echo "Adding the generated API-docs site..."
mkdir ./gh-pages/"$PACKAGE_VERSION"/
cp -r ./artifacts/apidocs/"$PACKAGE_VERSION"/. ./gh-pages/"$PACKAGE_VERSION"/

cd ./gh-pages

echo "Generating redirection page..."
# setup simple redirection to the latest version.

rm -f ./api.html
cat > "api.html" << EOL
<!DOCTYPE html>
<html>
<head>
<title>Redirecting...</title>
<meta charset="utf-8">
<link rel="canonical" href="https://mongodb.github.io/mongo-csharp-driver/${PACKAGE_VERSION}/api/index.html" />
<meta http-equiv="refresh" content="0; url=https://mongodb.github.io/mongo-csharp-driver/${PACKAGE_VERSION}/api/index.html" />
</head>
<body>
<p>Redirecting you to the <a href="https://mongodb.github.io/mongo-csharp-driver/${PACKAGE_VERSION}/api/index.html">latest API Docs</a>...</p>
</body>
</html>

EOL

echo "Pushing the changes..."
git add --all
git commit -m "Add $PACKAGE_VERSION Api docs" --author="Build Agent<dbx-csharp-dotnet@mongodb.com>"
git push --repo="$DOCS_REPO"

echo "Done."