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

Fool-proof submodules local/readthedocs.org integration #37

Closed
michaelweinold opened this issue Dec 19, 2022 · 5 comments
Closed

Fool-proof submodules local/readthedocs.org integration #37

michaelweinold opened this issue Dec 19, 2022 · 5 comments
Assignees
Milestone

Comments

@michaelweinold
Copy link
Contributor

@tngTUDOR mentioned the following potentially confusing case in #31 (comment):

  1. a contributor makes a change to a function docstring in eg. bw-calc, commiting his change to the main branch
  2. to check this change in the documentation Sphinx build, he pulls thesese changes into the bw-calc submodule in the brightway-documentation repo with git pull --recurse-submodules
  3. building the documentation locally, the changes are all present. however, unless the updated commit ID in the bw-calc submodule are commited+pushed, readthedocs.org will not have the changes until dependabot updates the submodules on remote.

This means that local/readthedocs.org versiond might be out-of-sync for a short time (until dependabot resolves these dependencies). This is true only for documentation created automatically from docstrings using AutoAPI.

@michaelweinold
Copy link
Contributor Author

michaelweinold commented Dec 19, 2022

Mitigation strategies:

  1. update the "documentation documentation" to include this case and give clear instructions on how to avoid this scenario
  2. auto-update the submodules on remote whenever changes in their respective upstream repositories are detected

Documentation:

  1. N/A
  2. Automatically updating git submodules using GitHub Actions or this SO thread (with more information on fine-grained access for machine users in this SO thread).

@michaelweinold
Copy link
Contributor Author

michaelweinold commented Dec 21, 2022

@michaelweinold
Copy link
Contributor Author

Issue: GITHUB_TOKEN is valid only within the repository of the workflow.

@michaelweinold
Copy link
Contributor Author

Add GH action to the following repos:

@michaelweinold michaelweinold modified the milestones: 0.2.0., 1.0.0 Jan 8, 2023
@michaelweinold
Copy link
Contributor Author

michaelweinold commented Jan 23, 2023

Check:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant