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

Fix build_docs github action + some minor improvements #143

Merged
merged 1 commit into from
Feb 10, 2022

Conversation

ben-albrecht
Copy link
Contributor

@ben-albrecht ben-albrecht commented Feb 10, 2022

Fix build_docs github action that was previously broken. Some other minor improvements were added as part of this fix.

Changes include:

  • build_docs action is triggered when we push to develop branch
    • Previously, it was on PR closed, which isn't necessarily a merge, i.e. a contributor could close a PR without merging and the action would still trigger
  • Use GITHUB_TOKEN instead of personal authentication (PA) credentials to push
  • Use "action@github.com" as the git author (user) to distinguish automated commits from human commits
  • Check static files from doc branch into develop, so that we can modify
    them in a regular PR to develop, rather than have to edit the doc branch
    directly. I'd like for us to get to a point where doc branch pushes are fully automated, so we should never have to modify it directly.
    • Static files include: .nojekyll (both top-level and per-sphinx-build), CNAME, and top-level index.html

@ben-albrecht
Copy link
Contributor Author

ben-albrecht commented Feb 10, 2022

Example build log here:

https://github.com/ben-albrecht/SmartSim/actions/runs/1824864337

This builds the docs from develop branch and deploys them to:

https://ben-albrecht.github.io/SmartSim/develop/

The master docs that were already checked into the doc branch are still visible as the top-level index.html:

https://ben-albrecht.github.io/SmartSim/docs/overview.html

@ben-albrecht
Copy link
Contributor Author

@Spartee - I noticed this is a different theme than read-the-docs. Is that an intentional change in the recent make docks changes in #133?

If we want RTD theme still, I can take a look at adjusting the requirements-docs.txt

@ben-albrecht ben-albrecht requested a review from Spartee February 10, 2022 17:02
@ben-albrecht
Copy link
Contributor Author

It looks like there is a separate incompatibility issue in our requirements-docs.txt, but I am not sure if that actually impacts anything other than showing an error during env build:

https://github.com/ben-albrecht/SmartSim/runs/5143975793?check_suite_focus=true#step:5:961

Fix build_docs github action that was previously broken.
Some minor improvements were added as part of this fix.

Changes include:

- build_docs action is triggered when we push to develop branch
    - Previously, it was on PR closed, which isn't necessarily a merge
- Use GITHUB_TOKEN instead of user credentials to push
- Use git user "action@github.com" to distinguish automated commits
- Check static files from doc branch into develop, so that we can modify
  them in a regular PR, rather than have to edit the doc branch
  directly.
    - This includes CNAME, index.html, .nojekyll

---
Signed-off-by: Ben Albrecht <ben-albrecht@users.noreply.github.com>
Copy link
Contributor

@Spartee Spartee left a comment

Choose a reason for hiding this comment

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

LGTM

@ben-albrecht
Copy link
Contributor Author

ben-albrecht commented Feb 10, 2022

@Spartee - I noticed this is a different theme than read-the-docs. Is that an intentional change in the recent make docks changes in #133?

For the archives, @Spartee mentioned that this was an intentional change.

@ben-albrecht ben-albrecht merged commit be73de2 into CrayLabs:develop Feb 10, 2022
@ben-albrecht ben-albrecht deleted the docs-fix branch February 10, 2022 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants