-
Notifications
You must be signed in to change notification settings - Fork 10
Conversation
057ed10
to
7591136
Compare
1f8e3fc
to
d5d3779
Compare
Since the automatic build and push of the docs happen on push to main and cannot be seen here, I tested it on my fork and it looks like this: https://github.com/sechkova/ml-conversational-analytic-tool/commits/main Also it needs actual changes to a "*.py" file to be triggered. This repository could have more restrictions however and the push could fail. Also signing the commit with a GPG key (-S) is not possible by a GH Action as far as I can tell (it is possible by creating a gpg key for this purpose but not in a trivial way). |
e9f8b9d
to
d5d3779
Compare
just as a reminder, after the PR is merged, we would have to enable github pages for the repo. I checked the repo setting and we do require signed commits. Could you test out what happens if you enable a signed commit requirement for your forked repo and test out what happens with the workflow there? |
@annajung I guess as expected, the commit is declined.
If we want to move forward the idea of an automatic commit, I'll check if it is possible to sign it in a GH Action. I'm not sure who should be the GPG key "owner" though. Here is the full log:
|
Use tox to generate the project documentation in an isolated and reproducible environment. Signed-off-by: Teodora Sechkova <[email protected]>
In order to use GitHub pages to automatically generate documentation from docs, an index file is needed in the root dir. However pdoc generates automatically the index file inside the docs/mcat dir. Add docs/index.html with a simple redirect to docs/mcat/index.html. Signed-off-by: Teodora Sechkova <[email protected]>
Add a new gh actions workflow to automatically build the docs and push them to the repository on each push to main. Signed-off-by: Teodora Sechkova <[email protected]>
Add a gh action step that checks for uncommitted docs and fails the CI. Signed-off-by: Teodora Sechkova <[email protected]>
Modify the trigger condiitons for the tests GH action to run only on pull requests and pushes to main branch. Signed-off-by: Teodora Sechkova <[email protected]>
Signed-off-by: Teodora Sechkova <[email protected]>
b234a81
to
2a49bc4
Compare
After checking the potential solututions, trying to surpass the brach protections tules by finding a way for a bot to sign the commits and sharing GPG keys as secrets sounds like an overkill for mcat, and also maybe raises some concerns. I have this new idea, I modified the workflow to only check for uncommitted changes after building the docs and fail. This way there is a visible mark in the PR of a failure and the PR author can rebuild and commit the docs before merging. @annajung what do you think? |
Closing to clean up for deprecation |
Fixes #20
Use gh actions to automatically generate the html API docs and add a new commit to the repository on each pull request.