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

chore: fix doc deployment (DSP-1492) #57

Merged
merged 5 commits into from Apr 12, 2021
Merged

chore: fix doc deployment (DSP-1492) #57

merged 5 commits into from Apr 12, 2021

Conversation

@BalduinLandolt
Copy link
Collaborator

@BalduinLandolt BalduinLandolt commented Apr 9, 2021

resolves DSP-1492

@BalduinLandolt BalduinLandolt self-assigned this Apr 9, 2021
@BalduinLandolt BalduinLandolt requested a review from kilchenmann Apr 9, 2021
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 }}
Copy link
Collaborator

@kilchenmann kilchenmann Apr 9, 2021

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...

Loading

Copy link
Collaborator Author

@BalduinLandolt BalduinLandolt Apr 9, 2021

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.

Loading

Copy link
Collaborator Author

@BalduinLandolt BalduinLandolt Apr 9, 2021

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.

Loading

Copy link
Collaborator

@kilchenmann kilchenmann Apr 9, 2021

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

Loading

Copy link
Collaborator Author

@BalduinLandolt BalduinLandolt Apr 9, 2021

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.

Loading

@BalduinLandolt BalduinLandolt requested a review from kilchenmann Apr 12, 2021
@BalduinLandolt BalduinLandolt merged commit a55849e into main Apr 12, 2021
2 checks passed
Loading
@BalduinLandolt BalduinLandolt deleted the wip/fix-deploy-docs branch Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants