Skip to content

Commit e72993d

Browse files
committed
Update github pages publish instructions to use our Github Action
1 parent b19b0c8 commit e72993d

File tree

2 files changed

+18
-42
lines changed

2 files changed

+18
-42
lines changed

README.md

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -93,34 +93,22 @@ jobs:
9393
9494
### GitHub Pages
9595
96-
To setup the tool to publish to GitHub pages use the following configuration.
97-
**NOTE**: In the near feature we'll make this a dedicated single step Github ction
96+
To set up the tool to publish to GitHub pages use the following configuration.
97+
**NOTE**: In the near feature we'll make this a dedicated single step GitHub action
9898
9999
```yaml
100+
environment:
101+
name: github-pages
102+
url: ${{ steps.deployment.outputs.page_url }}
100103
steps:
101-
- id: repo-basename
102-
run: 'echo "value=`basename ${{ github.repository }}`" >> $GITHUB_OUTPUT'
103104
- uses: actions/checkout@v4
104-
- name: Setup Pages
105-
id: pages
106-
uses: actions/[email protected]
107-
- name: Build documentation
108-
uses: elastic/docs-builder@main
109-
with:
110-
prefix: '${{ steps.repo-basename.outputs.value }}'
111-
- name: Upload artifact
112-
uses: actions/[email protected]
113-
with:
114-
path: .artifacts/docs/html
115-
116-
- name: Deploy artifact
105+
106+
- name: Publish Github
107+
uses: elastic/docs-builder/actions/publish@main
117108
id: deployment
118-
uses: actions/[email protected]
119109
```
120110
121-
Note `prefix:` is required to inject the appropiate `--path-prefix` argument to `docs-builder`
122-
123-
Also make sure your repository settings are set up to deploy from github actions see:
111+
Make sure your repository settings are set up to deploy from GitHub actions see:
124112
125113
https://github.com/elastic/{your-repository}/settings/pages
126114

docs/source/index.md

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -95,34 +95,22 @@ jobs:
9595
9696
### GitHub Pages
9797
98-
To setup the tool to publish to GitHub pages use the following configuration.
99-
**NOTE**: In the near feature we'll make this a dedicated single step Github ction
98+
To set up the tool to publish to GitHub pages use the following configuration.
99+
**NOTE**: In the near feature we'll make this a dedicated single step GitHub action
100100
101101
```yaml
102+
environment:
103+
name: github-pages
104+
url: ${{ steps.deployment.outputs.page_url }}
102105
steps:
103-
- id: repo-basename
104-
run: 'echo "value=`basename ${{ github.repository }}`" >> $GITHUB_OUTPUT'
105106
- uses: actions/checkout@v4
106-
- name: Setup Pages
107-
id: pages
108-
uses: actions/[email protected]
109-
- name: Build documentation
110-
uses: elastic/docs-builder@main
111-
with:
112-
prefix: '${{ steps.repo-basename.outputs.value }}'
113-
- name: Upload artifact
114-
uses: actions/[email protected]
115-
with:
116-
path: .artifacts/docs/html
117-
118-
- name: Deploy artifact
107+
108+
- name: Publish Github
109+
uses: elastic/docs-builder/actions/publish@main
119110
id: deployment
120-
uses: actions/[email protected]
121111
```
122112
123-
Note `prefix:` is required to inject the appropiate `--path-prefix` argument to `docs-builder`
124-
125-
Also make sure your repository settings are set up to deploy from github actions see:
113+
Make sure your repository settings are set up to deploy from GitHub actions see:
126114
127115
https://github.com/elastic/{your-repository}/settings/pages
128116

0 commit comments

Comments
 (0)