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

Add template workflows for managing a MkDocs-based website #25

Merged
merged 2 commits into from
Jun 16, 2021
Merged

Add template workflows for managing a MkDocs-based website #25

merged 2 commits into from
Jun 16, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jun 16, 2021 •
edited
Loading

These workflows:

  • Build the MkDocs-based website when any relevant file is modified to ensure no breakage occurred.
  • Deploy a non-versioned MkDocs-based website to GitHub Pages.

Notes

  • I will submit the versioned website system via a separate PR.
  • I did not take a Task-based approach for the deployment because this is not a process that will ever need to be run locally.

@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Jun 16, 2021
@per1234 per1234 requested review from silvanocerza and rsora June 16, 2021 09:32
per1234 added 2 commits June 16, 2021 02:36
@per1234
Add template workflow to deploy a MkDocs-based website to GitHub Pages
662a4cc 
On every push to the repository's default branch, deploy the repository's MkDocs-based static website to GitHub Pages.

This is the version of the workflow for use with Poetry.
@per1234
Add template workflow to check for problems with MkDocs-based website
4382387 
On every push or pull request that affects the source and configuration for the repository's MkDocs-based static
website, build the site and fail if any problems were encountered.
@per1234 per1234 merged commit 2484626 into main Jun 16, 2021
@per1234 per1234 deleted the mkdocs branch June 16, 2021 09:41
@per1234 per1234 self-assigned this Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@silvanocerza silvanocerza silvanocerza approved these changes

@rsora rsora Awaiting requested review from rsora

Assignees

@per1234 per1234

Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@per1234 @silvanocerza