Skip to content

Conversation

@Mpdreamz
Copy link
Member

@Mpdreamz Mpdreamz commented Aug 21, 2025

You may now set path locally in assembler.yml to point to a local checkout of a documentation set to ease validation changes on the asssembled build.

references:
  # @elastic/ingest-docs
  apm-server:
     path: <FULL_PATH_TO_LOCAL_CHECKOUT>
  apm-agent-android:

This is not allowed on CI and path will be cleared automatically if its set.

Integration tests with local docs-builder docs

This now also re-enables our integration tests and it uses this feature to inject:

  • The local docs folder from docs-builder as path in assembler.yml (and unsetting skip.
  • Adds it to the navigation (at the end of references).

This allows our CI to validate changes to docset.yml to our assemble process.

Updates to our aspire setup.

Our Aspire set up has now moved to a more logical place and makes it dead easy to start all services locally:

dotnet run --project aspire

Or if you want faster local builds you can do:

dotnet run --project aspire -- --skip-private-repositories --asume-cloned

I added a more in depth readme to document the why and how of our aspire setup.

https://github.com/elastic/docs-builder/blob/e37dbfd50b04ffdcaff6481bc98f47008bfeb034/aspire/README.md

Includes setup instructions, local services management, Elasticsearch instance configuration, user secrets, and tokenless CI workflows.
Only works locally.

If you specify `--skip-private-repositories` locally and we detect a solution file we automatically inject docs-builder in to the assembler navigation.

This allows our integration tests to tests new features in the assembler.
@Mpdreamz Mpdreamz requested a review from a team as a code owner August 21, 2025 10:09
@Mpdreamz Mpdreamz added the chore label Aug 21, 2025
@Mpdreamz Mpdreamz self-assigned this Aug 21, 2025
@Mpdreamz Mpdreamz added the chore label Aug 21, 2025
@Mpdreamz Mpdreamz changed the title feature/integration tests with docs builder in assembler Allow specifying custom path locally in assembler.yml Aug 21, 2025
@github-actions
Copy link

github-actions bot commented Aug 21, 2025

🔍 Preview links for changed docs

Copy link
Contributor

@cotti cotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Gonna be interesting to see how much more we can stretch Aspire in the future.

@Mpdreamz Mpdreamz merged commit 6242e2a into main Aug 21, 2025
19 checks passed
@Mpdreamz Mpdreamz deleted the feature/integration-tests-with-docs-builder-in-assembler branch August 21, 2025 12:12
@theletterf
Copy link
Contributor

Sweet!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants