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
49 changes: 48 additions & 1 deletion .github/workflows/test-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@ on:
pull_request:
types: [opened, reopened, synchronize]
workflow_dispatch:
inputs:
redpanda_version:
description: 'Redpanda version to test, such as v26.2.1. Defaults to the latest stable GitHub release (stable vs beta channel decided by antora.yml).'
required: false
type: string
redpanda_docker_repo:
description: 'Redpanda Docker repo, such as redpanda or redpanda-unstable (for RCs). Defaults to redpanda (redpanda-unstable when antora.yml is in beta mode and an RC exists).'
required: false
type: string
console_version:
description: 'Redpanda Console version to test, such as v3.9.0. Defaults to the latest stable GitHub release (stable vs beta channel decided by antora.yml).'
required: false
type: string
console_docker_repo:
description: 'Console Docker repo, such as console. Defaults to console.'
required: false
type: string
repository_dispatch:
types: [trigger-tests]

Expand All @@ -15,6 +32,7 @@ jobs:
console: ${{ steps.filter.outputs.console }}
quickstart: ${{ steps.filter.outputs.quickstart }}
kindguide: ${{ steps.filter.outputs.kindguide }}
versions: ${{ steps.filter.outputs.versions }}
steps:
- name: Checkout code
uses: actions/checkout@v4
Expand All @@ -31,6 +49,14 @@ jobs:
- 'modules/deploy/pages/redpanda/kubernetes/local-guide.adoc'
- 'modules/deploy/partials/kubernetes/**'
- 'antora.yml'
# A version-bump PR signals a new Redpanda or Console release. The
# quickstart test resolves the LATEST STABLE release at runtime
# (not the antora.yml pins), so running it on bump PRs catches
# breakage from that release before merge instead of in the
# nightly run. antora.yml deliberately appears here and under
# kindguide: dorny/paths-filter filters evaluate independently.
versions:
- 'antora.yml'

run-tests:
needs: setup
Expand Down Expand Up @@ -87,9 +113,30 @@ jobs:
# body limit. The doc-detective-output artifact has the JSON.
issue_body: "A Doc Detective run ($RUN_URL) failed. Download the doc-detective-output artifact on the run for full results."
token: ${{ env.ACTIONS_BOT_TOKEN }}
# Optional version overrides. Manual runs set them through workflow
# inputs. Upstream repos (for example Console releases or Redpanda RC
# builds) set them through the trigger-tests dispatch payload. When
# unset, the test resolves the latest stable GitHub release for each
# product (doc-tools get-redpanda-version / get-console-version;
# antora.yml only decides stable vs beta), not the antora.yml pins.
#
# Cross-repo contract for senders: repository_dispatch event type
# `trigger-tests`, client_payload keys `redpanda_version`,
# `redpanda_docker_repo`, `console_version`, `console_docker_repo`.
#
# The env var names are consumed by
# tests/setup-tests/fetch-versions-and-rpk.json: renaming a variable
# there silently disables its override here. These overrides attach
# only to this all-tests step; a future dispatch that runs only the
# quickstart step would need the same env block there.
env:
REDPANDA_VERSION: ${{ github.event.inputs.redpanda_version || github.event.client_payload.redpanda_version }}
REDPANDA_DOCKER_REPO: ${{ github.event.inputs.redpanda_docker_repo || github.event.client_payload.redpanda_docker_repo }}
REDPANDA_CONSOLE_VERSION: ${{ github.event.inputs.console_version || github.event.client_payload.console_version }}
CONSOLE_DOCKER_REPO: ${{ github.event.inputs.console_docker_repo || github.event.client_payload.console_docker_repo }}

- name: Test Redpanda Streaming quickstart
if: ${{ needs.setup.outputs.quickstart == 'true' || needs.setup.outputs.console == 'true' }}
if: ${{ needs.setup.outputs.quickstart == 'true' || needs.setup.outputs.console == 'true' || needs.setup.outputs.versions == 'true' }}
uses: doc-detective/github-action@v1
with:
input: ../../modules/get-started/pages/quick-start.adoc
Expand Down
Loading