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

Documentation: housekeeping dependencies and CI #175

Merged
merged 3 commits into from
Feb 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ on:
tags:
- "*"

pull_request:
branches: [main]
paths:
- ".github/workflows/documentation.yml"
- requirements/documentation.txt

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
Expand Down Expand Up @@ -54,15 +60,26 @@ jobs:
- name: Build static website
run: mkdocs build --verbose

- name: Save build doc as artifact
uses: actions/upload-artifact@v3
with:
name: documentation
path: site/
if-no-files-found: error
retention-days: 30

- name: Setup Pages
uses: actions/configure-pages@v3
if: github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main')

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
if: github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main')
with:
# Upload entire repository
path: site
path: site/

- name: Deploy to GitHub Pages
id: deployment
if: github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main')
uses: actions/deploy-pages@v1
3 changes: 0 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
setuptools
wheel

-r requirements/base.txt

-e "."
2 changes: 1 addition & 1 deletion requirements/development.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
black
feedparser>=6.0,<6.1
flake8>=4,<6.1
pre-commit>=2.10,<3.1
pre-commit>=3,<3.2
pytest-cov==4.0.*
validator-collection>=1.5,<1.6
2 changes: 1 addition & 1 deletion requirements/documentation.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Documentation
# -----------------------
mkdocs-bootswatch>=1,<2
mkdocs-minify-plugin==0.5.*
mkdocs-minify-plugin==0.6.*
pygments>=2.5,<3
pymdown-extensions>=7,<10