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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 5 commits into from Apr 12, 2021
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0d41a8f
chore: fix docs deployment
BalduinLandolt Apr 9, 2021
5ebc11d
fix: remove wrong requirements reference
BalduinLandolt Apr 9, 2021
1210175
chore: add temporary test-docs workflow
BalduinLandolt Apr 9, 2021
8b8e46f
chore: add separate requirements for docs
BalduinLandolt Apr 9, 2021
2797917
chore: remove docs test
BalduinLandolt Apr 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 5 additions & 13 deletions .github/workflows/release.yml
View file
Open in desktop
Expand Up @@ -42,20 +42,12 @@ jobs:
steps:
# check out repo
- uses: actions/checkout@v2
with:
fetch-depth: 1
# install python
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.9'
# install pythonn dependencies
- name: Install dependencies
run: |
python -m pip install --upgrade pip
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 }}
Comment on lines -56 to +49
Copy link

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

Copy link
Collaborator Author

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.

Copy link
Collaborator Author

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.

Copy link

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

Copy link
Collaborator Author

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.

REQUIREMENTS: docs/requirements.txt

notification:
name: Google chat notification about release and published version
Expand Down
3 changes: 3 additions & 0 deletions docs/requirements.txt
View file
Open in desktop
@@ -0,0 +1,3 @@

mkdocs
mkdocs-material