Skip to content

feature/config folder arg #1580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 29, 2025
Merged

feature/config folder arg #1580

merged 3 commits into from
Jul 29, 2025

Conversation

Mpdreamz
Copy link
Member

@Mpdreamz Mpdreamz commented Jul 18, 2025

This allows the build to source the configuration prior to cloning and building

docs-assembler repo init-config
docs-assembler repo clone-all
docs-assembler repo build-all

On production we can lock the configuration to a commit using --git-ref sha.

I think we want to automate opening PR's to update that sha to the last commit on our config folder. We can then merge it once we know staging is still good.

ConfigurationFileProvider will look at

  • {pwd}/config, development
  • {app_data}/config, (where init-config clones too)
  • embedded sources

We also now log the configuration source and in case of app_data also the git reference.

Mpdreamz added 2 commits July 18, 2025 15:14
This allows the build to source the configuration prior to cloning and building

docs-assembler repo init-config
docs-assembler repo clone-all
docs-assembler repo build-all

On production we can lock the configuration to a commit using `--git-ref sha`.

ConfigurationFileProvider will look at

- {pwd}/config, development
- {app_data}/config, (where init-config clones too)
- embedded sources

We also now log the configuration source and in case of app_data also the git reference.
@Mpdreamz Mpdreamz requested a review from a team as a code owner July 18, 2025 16:08
@Mpdreamz Mpdreamz self-assigned this Jul 18, 2025
[EnumExtensions]
public enum ConfigurationSource
{
Local,
Copy link
Member

Choose a reason for hiding this comment

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

Can we use local and put the config in elastic/docs-internal-workflows?

Copy link
Member Author

Choose a reason for hiding this comment

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

We could, as source of truth or as a copy?

I think we want the source of truth to remain in docs-builder.

Copy link
Member

Choose a reason for hiding this comment

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

Maybe it's just me. But I like to think that the config is close to the place where it's being deployed from.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think config should live where its read.

If it lives in elastic/docs-internal-workflows we'd need multiple copies for each environment.

We can do a lot more PR validations from this repository too IMO. Let's discuss today :)

@Mpdreamz
Copy link
Member Author

Leaving this open until after 9.1 goes out the door so we minimize new moving parts.

@bmorelli25
Copy link
Member

Sounds good. Closes #1434.

@bmorelli25 bmorelli25 linked an issue Jul 21, 2025 that may be closed by this pull request
2 tasks
@Mpdreamz
Copy link
Member Author

Merging this in, we won't use docs-assembler repo init-config but will leave that for a follow up PR.

@Mpdreamz Mpdreamz merged commit 93f171e into main Jul 29, 2025
17 checks passed
@Mpdreamz Mpdreamz deleted the feature/config-folder-arg branch July 29, 2025 11:25
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.

Decouple assembler config from docs-builder release process
3 participants