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

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

Merged
merged 1 commit into from
Jun 27, 2024

Conversation

jsumners-nr
Copy link
Contributor

This PR resolves #2301. Instead of trying to merge in changes to the gh-pages branch, we simply recreate it every time.

@jsumners-nr jsumners-nr added the dev:automation Indicates CI automation label Jun 27, 2024
@mrickard mrickard self-assigned this Jun 27, 2024
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?

@jsumners-nr jsumners-nr merged commit 917110a into newrelic:main Jun 27, 2024
19 checks passed
@jsumners-nr jsumners-nr deleted the issue-2301 branch June 27, 2024 19:51
This was referenced Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev:automation Indicates CI automation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Fix post release API docs publish
3 participants