-
Notifications
You must be signed in to change notification settings - Fork 4
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: fix doc deployment (DSP-1492) #57
Conversation
pip install -r requirements.txt | ||
# release latest docs | ||
- run: make publish-docs | ||
- name: Deploy docs | ||
uses: mhausenblas/mkdocs-deploy-gh-pages@master | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the "install requirements" is missing. You can add it to the /mkdocs-deploy-gh-pages
action:
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
REQUIREMENTS: requirements.txt
But I'm not sure about your list of requirements. I think in this repo they're not for the documentation only. Maybe it could give you a conflict. You should try to run the action on the next push. Otherwise we will see the action only in the next release process...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in the example usage they don't have it, so I assume it defaults to the ./requirements.txt
.
Yes, I'll run it and we'll see if it works or if it needs separate requirements.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But in order to be able to run it, I need to merge this PR, I think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can activate this step on push.. Move it into a separate but temporary workflow script and to run it with next commit
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the requirements did indeed cause problems. I now reused the solution with the separate requirements file for the docs, and now it works.
resolves DSP-1492