Страница:
Publishing Jazzy Docs to GitHub.io
Страницы
Generating Swift Interface Files
Home
Partner Release Process
Publishing Cocoapods
Publishing Jazzy Docs to GitHub.io
Release Process
Releasing the SDK
Renewing Trunk Access
Style Guidance for Objective C Code
Testing in AppCenter
Using Swift APIView
Writing End to End Tests using AzureTest
iOS Testing Needs
14
Publishing Jazzy Docs to GitHub.io
Travis Prescott редактировал(а) эту страницу 2022-06-21 11:10:01 -07:00
- Ensure that all Jazzy configurations in
jazzy/*.yml
are updated with the current SDK version. - Install the latest version of Jazzy with
gem install jazzy
and your pod repo is up-to-date withpod repo update trunk
. - Ensure you are at the root directory of the
azure-sdk-for-ios
repo. - Ensure you are on the
main
branch. Runpod install
to ensure the Pods project is up-to-date. For external repos, the script will install your Podfile after is clones the repo. - Clear any cached data with:
rm -rf build/
- Run
python eng/scripts/build_api_docs.py <library name> <library name> ...
to generate Jazzy docs for all the libraries that are published. This step also generates a newindex.html
page which has a link to ONLY the libraries you just generated. So if you only generated updated docs for one existing library, DO NOT replace theindex.html
page in step 9. - Run
git checkout gh-pages
to check out thegh-pages
branch. - Run
rm -rf Azure*
to delete all top-level documentation directories. This ensures that we delete the docs for types that have been removed since the last publish. - Run
mv build/jazzy/* .
to move all the new docs and the newindex.html
page into the root of the repo. - Run
git add <library name> <library name> ...
to stage all the new docs. If you are updating theindex.html
page, also add that withgit add index.html
. - Run
git commit --amend --no-edit
to amend the ONE AND ONLY docs commit in thegh-pages
branch. Do NOT add a new commit. This prevents the repo size from growing significantly due to storing all old revisions of the docs site. - Run
git push upstream gh-pages --force
to push the new docs. The docs site will automatically be rebuilt and should be live within a minute or so.
- Home
- Testing
- Release