1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Pages bump samples (#53190)

Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com>
This commit is contained in:
Yoann Chaudet
2024-12-02 15:02:26 -08:00
committed by GitHub
parent 37290216d8
commit 89b5de92c8
2 changed files with 47 additions and 10 deletions

View File

@@ -23,7 +23,7 @@ To use the action place this snippet under your `jobs` in the desired workflow.
```yaml
- name: Configure GitHub Pages
uses: actions/configure-pages@v3
uses: actions/configure-pages@v5
```
This action helps support deployment from any static site generator to {% data variables.product.prodname_pages %}. To make this process less repetitive you can use workflow templates for some of the most widely used static site generators. For more information, see "[AUTOTITLE](/actions/learn-github-actions/using-starter-workflows)."
@@ -36,7 +36,13 @@ To use the action in your current workflow place this snippet under `jobs`.
```yaml
- name: Upload GitHub Pages artifact
{%- ifversion fpt or ghec %}
uses: actions/upload-pages-artifact@v3
{%- elsif pages-custom-workflow-ghes3-9 %}
uses: actions/upload-pages-artifact@v2
{%- else %}
uses: actions/upload-pages-artifact@v1
{%- endif %}
```
## Deploying {% data variables.product.prodname_pages %} artifacts
@@ -50,8 +56,6 @@ The `deploy-pages` action handles the necessary setup for deploying artifacts. T
For more information, see the [`deploy-pages`](https://github.com/marketplace/actions/deploy-github-pages-site) action.
{% raw %}
```yaml
# ...
@@ -65,16 +69,20 @@ jobs:
needs: jekyll-build
environment:
name: github-pages
url: ${{steps.deployment.outputs.page_url}}
url: {% raw %}${{steps.deployment.outputs.page_url}}{% endraw %}
steps:
- name: Deploy artifact
id: deployment
{%- ifversion fpt or ghec %}
uses: actions/deploy-pages@v4
{%- elsif pages-custom-workflow-ghes3-9 %}
uses: actions/deploy-pages@v3
{%- else %}
uses: actions/deploy-pages@v1
{%- endif %}
# ...
```
{% endraw %}
## Linking separate build and deploy jobs
You can link your `build` and `deploy` jobs in a single workflow file, eliminating the need to create two separate files to get the same result. To get started on your workflow file, under `jobs` you can define a `build` and `deploy` job to execute your jobs.
@@ -91,14 +99,20 @@ jobs:
uses: {% data reusables.actions.action-checkout %}
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
uses: actions/configure-pages@v5
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./
destination: ./_site
- name: Upload artifact
{%- ifversion fpt or ghec %}
uses: actions/upload-pages-artifact@v3
{%- elsif pages-custom-workflow-ghes3-9 %}
uses: actions/upload-pages-artifact@v2
{%- else %}
uses: actions/upload-pages-artifact@v1
{%- endif %}
# Deployment job
deploy:
@@ -110,7 +124,13 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
{%- ifversion fpt or ghec %}
uses: actions/deploy-pages@v4
{%- elsif pages-custom-workflow-ghes3-9 %}
uses: actions/deploy-pages@v3
{%- else %}
uses: actions/deploy-pages@v1
{%- endif %}
# ...
```
@@ -130,15 +150,27 @@ jobs:
- name: Checkout
uses: {% data reusables.actions.action-checkout %}
- name: Setup Pages
uses: actions/configure-pages@v3
uses: actions/configure-pages@v5
- name: Upload Artifact
{%- ifversion fpt or ghec %}
uses: actions/upload-pages-artifact@v3
{%- elsif pages-custom-workflow-ghes3-9 %}
uses: actions/upload-pages-artifact@v2
{%- else %}
uses: actions/upload-pages-artifact@v1
{%- endif %}
with:
# upload entire directory
path: '.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
{%- ifversion fpt or ghec %}
uses: actions/deploy-pages@v4
{%- elsif pages-custom-workflow-ghes3-9 %}
uses: actions/deploy-pages@v3
{%- else %}
uses: actions/deploy-pages@v1
{%- endif %}
# ...
```

View File

@@ -0,0 +1,5 @@
# Issue 5102 for the GHES release
# Publishing Pages via custom Actions workflow in GHES >= 3.9
# https://github.com/actions/deploy-pages?tab=readme-ov-file#compatibility
versions:
ghes: '>=3.9'