Redis
redis-vl-dotnet Documentation redis-vl-dotnet

redis-vl-dotnet

Testing

This section captures the current validation commands and docs publishing requirements.

Local validation

Build the Antora site from the repository root:

npm install
npm run docs:validate

The generated static site is written to build/site.

Build every example project from the repository root:

npm run examples:build

This sweep restores and builds each examples/*.csproj entry so docs-linked samples fail fast when they drift from the current library surface.

CI validation

.github/workflows/ci.yml runs the same repository-root commands used locally:

  • npm run docs:validate

  • npm run examples:build

Because Antora exits on broken navigation or missing page references, the docs validation job blocks CI on docs-site drift. Because the example sweep builds every sample project, CI also blocks merges when a documented example stops compiling.

GitHub Actions publishing

GitHub Pages publishing is defined in .github/workflows/docs-pages.yml. The workflow:

  • runs on pushes to main and on manual dispatch

  • installs the repository Node.js dependencies with npm ci

  • builds the Antora site with npm run docs:validate

  • uploads build/site as the Pages artifact

  • deploys only after the build job succeeds

Because the deploy job depends on the build job, a failed docs build blocks publishing.

Required repository configuration

Before the workflow can publish successfully, configure the repository Pages source to GitHub Actions in GitHub repository settings.

The workflow requests the permissions required by GitHub Pages deployments:

  • contents: read

  • pages: write

  • id-token: write