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.

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

chore: Forced re-creation of API docs on gh-pages #2307

Merged
merged 1 commit into from
Jun 27, 2024
Merged

chore: Forced re-creation of API docs on gh-pages #2307

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
8 changes: 4 additions & 4 deletions bin/publish-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ PACKAGE_VERSION=$(node -e 'console.log(require("./package").version)')

git fetch origin gh-pages
git checkout gh-pages
git merge -
git checkout main
git branch -fd gh-pages
git checkout -b gh-pages
npm run public-docs
sleep 1
git rm -r docs
sleep 1
mv out docs
sleep 1
git add docs
git commit -m "docs: update for ${PACKAGE_VERSION}"
git push origin gh-pages
git push --force origin gh-pages
Copy link
Member

Choose a reason for hiding this comment

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

do we want to --force-with-lease instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My understanding, based upon https://stackoverflow.com/a/52823955, is that it doesn't offer any benefit. We don't make any changes to the gh-pages branch other than to push up new API docs builds. Do you agree? Or do you still think we should try --force-with-lease?