Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,15 +102,36 @@ jobs:
To set up the tool to publish to GitHub Pages, use the following configuration.

```yaml
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4

- name: Publish Github
uses: elastic/docs-builder/actions/publish@main
id: deployment
name: Build the docs

on:
push:
branches:
- main
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
docs:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Check out the repo
uses: actions/checkout@v4

- name: Publish Github
uses: elastic/docs-builder/actions/publish@main
id: deployment
with:
continue-on-error: "true"
private: true
```

This single action will build and validate the documentation before publishing.
Expand Down
Loading