Sphinx - core #1930
Add GH actions deploy script
- Loading branch information
commit 0f2033e932dadcf8ac0f589dc0e42d3b1e7a9dcd
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| name: Deploy to GitHub Pages | ||
|
|
||
| on: [push] | ||
|
|
||
| jobs: | ||
| deploy-to-pages: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: 🛎️ Checkout | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: 🐍 Set up Python 3.9 | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: 3.9 | ||
|
|
||
| - name: 🧳 Cache pip | ||
| uses: actions/cache@v2 | ||
| with: | ||
| # This path is specific to Ubuntu | ||
| path: ~/.cache/pip | ||
| # Look to see if there is a cache hit for the corresponding requirements file | ||
| key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-pip- | ||
| ${{ runner.os }}- | ||
|
|
||
| # Install dependencies and build PEPs using sphinx | ||
| - name: 👷 Install dependencies | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install -r requirements.txt | ||
| make pages | ||
|
|
||
| # Install dependencies and build PEPs using sphinx | ||
| - name: 🔧 Build PEPs | ||
| run: make pages | ||
|
|
||
| - name: 🚀 Deploy to GitHub pages | ||
| uses: JamesIves/[email protected] | ||
| with: | ||
| BRANCH: gh-pages # The branch the action should deploy to. | ||
| FOLDER: build # The folder the action should deploy. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AA-Turner I think we don't deploy on the GitHub pages... What's the reason for this workflow?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't currently. #1385 has extensive discussion on this (#1385 (comment) etc) - the main drive is that deploying to GH pages is easy and free, and enables previewing the changes before any switchovers etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also discussion in various other issues (#2, #3, #25) and others I've likely forgoton (may be some on the pythondotorg repo)