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

Documentation builds not triggered when README.md, CONTRIBUTING.md, LICENCE.txt altered #274

Closed
mfisher87 opened this issue Aug 6, 2023 · 3 comments

Comments

@mfisher87
Copy link
Collaborator

mfisher87 commented Aug 6, 2023

These files are symlinked into the docs directory, and our workflow is triggered by changes in the docs directory. GitHub Actions does not recognize a change to README.md as a change to the symlink docs/index.md, so if the README is changed, docs don't build. I tested this on a fork.

mfisher87#4

@jrbourbeau
Copy link
Collaborator

Circling back here. I think the recent readthedocs work closes this issue as now we get a documentation build + preview on all PRs. I'm going to close this issue as fixed, but feel free to re-open is that's not the case @MattF-NSIDC

@mfisher87
Copy link
Collaborator Author

mfisher87 commented Oct 21, 2023

I think we need to clean up and simplify some GHA YAML:

  • Ignore Pull Request event - RTD does this
  • Update paths list for push events - we want GH Pages docs to match RTD when README.md is changed, for example.
  • Simplify this conditional, should just be checking if branch == main|documentation - the rest is vestigial IIRC

@mfisher87
Copy link
Collaborator Author

mfisher87 commented Oct 21, 2023

I'm opening a quick PR so we don't have to open anything else to track that :)

EDIT: #324

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

No branches or pull requests

2 participants