Skip to content

SWIFT-734 Update scripts to maintain multiple versions of the documentation #58

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

Merged
merged 1 commit into from
Feb 5, 2021
Merged

SWIFT-734 Update scripts to maintain multiple versions of the documentation #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion etc/docs-main.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ This is the documentation for the official MongoDB Swift BSON library, [swift-bs

You can view the README for this project, including installation instructions, [here](https://github.com/mongodb/swift-bson/blob/master/README.md).

The documentation for the official MongoDB Swift driver, which depends on this BSON library, can be found [here](https://mongodb.github.io/mongo-swift-driver/MongoSwift/index.html).
Documentation for other versions of `swift-bson` can be found [here](https://mongodb.github.io/swift-bson/docs).

The documentation for the official MongoDB Swift driver, which depends on `swift-bson`, can be found [here](https://mongodb.github.io/mongo-swift-driver/MongoSwift/index.html).
35 changes: 14 additions & 21 deletions etc/generate-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,25 @@ if ! command -v jazzy > /dev/null; then
gem install jazzy || { echo "ERROR: Failed to locate or install jazzy; please install yourself with 'gem install jazzy' (you may need to use sudo)"; exit 1; }
fi

if ! command -v sourcekitten > /dev/null; then
echo "ERROR: Failed to locate SourceKitten; please install yourself and/or add to your \$PATH"; exit 1
fi

version=${1}

# Ensure version is non-empty
[ ! -z "${version}" ] || { echo "ERROR: Missing version string"; exit 1; }

jazzy \
--github-file-prefix https://github.com/mongodb/swift-bson/tree/v${version} \
--module-version "${version}" \
--output "docs-temp/SwiftBSON" \
--config .jazzy.yml

# switch to docs branch to commit and push
git stash
git checkout gh-pages

rm -rf docs/*
cp -r docs-temp/* docs/
rm -rf docs-temp

git add docs/
jazzy_args=(--clean
--github-file-prefix https://github.com/mongodb/swift-bson/tree/v${version}
--module-version "${version}")

echo '<html><head><meta http-equiv="refresh" content="0; url=BSON/index.html" /></head></html>' > docs/index.html
git add docs/index.html
sourcekitten doc --spm --module-name SwiftBSON > swift-bson-docs.json
args=("${jazzy_args[@]}" --output "docs-temp/SwiftBSON" --module "SwiftBSON" --config ".jazzy.yml"
--sourcekitten-sourcefile swift-bson-docs.json
--root-url "https://mongodb.github.io/swift-bson/docs/SwiftBSON/")
jazzy "${args[@]}"

git commit -m "${version} docs"
git push
echo '<html><head><meta http-equiv="refresh" content="0; url=SwiftBSON/index.html" /></head></html>' > docs-temp/index.html

# go back to wherever we started
git checkout -
rm swift-bson-docs.json
17 changes: 17 additions & 0 deletions etc/release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,23 @@ version=${1}
# regenerate documentation with new version string
./etc/generate-docs.sh ${version}

# switch to docs branch to commit and push
git checkout gh-pages

rm -r docs/current
cp -r docs-temp docs/current
mv docs-temp docs/${version}

# build up documentation index
python3 ./_scripts/update-index.py

git add docs/
git commit -m "${version} docs"
git push

# go back to wherever we started
git checkout -

# tag release and push tag
git tag "v${version}"
git push --tags
Expand Down