test

Author: reakaleek

actions/preview/README.md

@@ -0,0 +1,54 @@
+<!-- 
+    this documentation was generated by https://github.com/reakaleek/gh-action-readme 
+    with the command `VERSION=main gh action-readme update`    
+-->
+
+# <!--name-->Documentation Preview<!--/name-->
+
+<!--description-->
+Builds and publishes documentation to preview environment
+<!--/description-->
+
+## Inputs
+
+<!--inputs-->
+| Name     | Description                                         | Required | Default |
+|----------|-----------------------------------------------------|----------|---------|
+| `strict` | Whether to fail the build if there are any warnings | `false`  | `true`  |
+<!--/inputs-->
+
+
+## Usage
+
+<!--usage action="elastic/docs-builder/actions/preview" version="env:VERSION"-->
+```yaml
+name: Documentation Preview
+
+on:
+  pull_request: ~
+  pull_request_target:
+    types:
+      - closed
+  push:
+    branches:  
+      - main # Depends on the default branch name of the repository
+
+permissions:
+  contents: read
+  id-token: write
+  deployments: write
+
+# Ensure only one workflow runs at a time for a given branch/PR
+# Cancel any in-progress runs when a new commit is pushed, except on main branch
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: elastic/docs-builder/actions/preview@main
+```
+<!--/usage-->