Skip to content

Commit

Permalink
Docs: GitHub Pages workflow not officially supported
Browse files Browse the repository at this point in the history
  • Loading branch information
justinmayer committed May 29, 2024
1 parent 0b5934a commit e4d7f0a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/workflows/github_pages.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Workflow for publishing to GitHub Pages. **NO OFFICIAL SUPPORT PROVIDED.**
name: Deploy to GitHub Pages
on:
workflow_call:
Expand Down
5 changes: 3 additions & 2 deletions docs/tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,9 @@ branch of your GitHub repository::
Publishing to GitHub Pages Using a Custom GitHub Actions Workflow
-----------------------------------------------------------------

Pelican comes with a `custom workflow <https://github.com/getpelican/pelican/blob/master/.github/workflows/github_pages.yml>`_
for publishing a Pelican site. To use it:
Pelican-powered sites can be published to GitHub Pages via a `custom workflow
<https://github.com/getpelican/pelican/blob/master/.github/workflows/github_pages.yml>`_.
**No official support is provided** for this community-submitted workflow. To use it:

1. Enable GitHub Pages in your repo: go to **Settings → Pages** and choose
**GitHub Actions** for the **Source** setting.
Expand Down

0 comments on commit e4d7f0a

Please sign in to comment.