Allow limited public assembler builds on docs-builder #2379
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
src/services/Elastic.Documentation.Assembler/Building/AssemblerBuildService.cs
Fixed
Show fixed
Hide fixed
src/services/Elastic.Documentation.Assembler/Building/AssemblerBuilder.cs
Fixed
Show fixed
Hide fixed
src/services/Elastic.Documentation.Assembler/Building/AssemblerBuildService.cs
Fixed
Show fixed
Hide fixed
src/services/Elastic.Documentation.Assembler/Sourcing/RepositorySourcesFetcher.cs
Fixed
Show fixed
Hide fixed
Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
Mpdreamz
requested changes
Dec 17, 2025
Member
Mpdreamz
left a comment
Mpdreamz
left a comment
There was a problem hiding this comment.
Nice! Some changes requested.
.github/workflows/preview-build.yml
Outdated
| env: | ||
| AWS_RETRY_MODE: standard | ||
| AWS_MAX_ATTEMPTS: 6 | ||
| ASSEMBLER_PREVIEW_PATH_PREFIX: ${{ github.repository }}/assembled-docs/${{ github.event.pull_request.number }} |
Member
There was a problem hiding this comment.
Suggested change
| ASSEMBLER_PREVIEW_PATH_PREFIX: ${{ github.repository }}/assembled-docs/${{ github.event.pull_request.number }} | |
| ASSEMBLER_PREVIEW_PATH_PREFIX: ${{ github.repository }}/docs/${{ github.event.pull_request.number }} |
Mpdreamz
reviewed
Dec 17, 2025
.github/workflows/preview-build.yml
Outdated
| log_url: `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`, | ||
| }) | ||
| - name: Create Assembler Deployment |
Member
There was a problem hiding this comment.
Lost a comment, lets move this to dedicated new workflow file. This shared one is tooo complex already and shouldn't trigger on labeled.
reakaleek
reviewed
Dec 17, 2025
Mpdreamz
requested changes
Dec 18, 2025
| name: assembler-preview | ||
|
|
||
| on: | ||
| workflow_dispatch: |
| default: false | ||
| required: false | ||
|
|
Member
There was a problem hiding this comment.
Revert this file completely (the whitespace clean up is good but lets not make it part of this PR).
| public async ValueTask<bool> FinishExportAsync(IDirectoryInfo outputFolder, Cancel ctx) | ||
| { | ||
| var outputDirectory = Path.Combine(outputFolder.FullName, "docs"); | ||
| var outputDirectory = outputFolder.FullName; |
Member
There was a problem hiding this comment.
We expose llm.zip on elastic.co so I think this needs to be put under docs again.
| doc.Add(root); | ||
|
|
||
| using var fileStream = fileSystem.File.Create(Path.Combine(outputFolder.ToString() ?? string.Empty, "docs", "sitemap.xml")); | ||
| using var fileStream = fileSystem.File.Create(fileSystem.Path.Combine(outputFolder.FullName, "sitemap.xml")); |
Member
There was a problem hiding this comment.
sitemap.xml has to live under docs/sitemap.xml
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem Overview
Certain changes in docs-builder that are best viewed from an assembler build perspective can benefit from the collective review from writers, but it's not always straightforward to share specific links, show regressions, etc.
Allowing a limited assembler preview for docs-builder pull requests would allow for earlier and broader QA, and faster communication during feature development.
Proposed solution
This PR adds a new workflow to docs-builder that builds an assembler preview to a given PR #.
It contains the following limitations:
Other changes
llms.txt,sitemap.xmlandlink-index.snapshot.jsongeneration relied on hardcoded paths, which were incompatible with the previews introduced here. If there is a path prefix available, we now make use of it.