Skip to content
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

Documentation freeze: github action PR's #281

Open
28 of 72 tasks
Mpdreamz opened this issue Jan 21, 2025 · 5 comments
Open
28 of 72 tasks

Documentation freeze: github action PR's #281

Mpdreamz opened this issue Jan 21, 2025 · 5 comments
Assignees
Labels
automation packaging, ci/cd.

Comments

@Mpdreamz
Copy link
Member

Mpdreamz commented Jan 21, 2025

For the documentation freeze we need to ensure the following repositories have the documentation freeze github action set up.

This action only comments making everyone aware of the freeze. It won't block PR's from being merged

See: https://elastic.github.io/docs-builder/migration/freeze/gh-action.html

This meta ticket exists as a way to track all the repositories currently publishing in V1.

The PR's will be opened through a one off script to all of these.

External

@Mpdreamz Mpdreamz added the automation packaging, ci/cd. label Jan 21, 2025
@Mpdreamz Mpdreamz self-assigned this Jan 21, 2025
@bmorelli25
Copy link
Member

@reakaleek might have pre-made tooling from the robots team to handle this? I think I've seen something from Victor in the past?

@reakaleek
Copy link
Member

FYI, I verified that the code snippet works at https://github.com/elastic/docs-eng-playground/pull/4

@reakaleek
Copy link
Member

But I'm wondering if the check should fail?

@reakaleek
Copy link
Member

reakaleek commented Jan 24, 2025

@reakaleek might have pre-made tooling from the robots team to handle this? I think I've seen something from Victor in the past?

Yup. We were using https://github.com/elastic/gh-oblt which has the gh oblt change apply command.

We only had it because we had changes to multiple repos quite frequently and it can handle complex changes.

This is a rather simple use case.

I can definitely do it. But I don't think it's worth it, if you are not familiar with the tool.

TL;DR

I can take over this if you like to. But I imagine a one off script is perfectly fine in this case too.

@bmorelli25 bmorelli25 assigned reakaleek and unassigned Mpdreamz Jan 27, 2025
This was referenced Jan 28, 2025
This was referenced Jan 28, 2025
@reakaleek
Copy link
Member

I had to re-run the script and replace pull_request with pull_request_target.

Otherwise, the workflow will fail to comment on PRs from forks.

shainaraskas pushed a commit to elastic/kibana that referenced this issue Jan 30, 2025
## Details

⚠️ This PR was created by an automated tool. Please review the changes
carefully. ⚠️

Add a workflow that will comment on PRs with AsciiDoc changes.

## Why

During the migration to Elastic Docs v3, the Docs team will focus
exclusively on migrating content.
To maintain consistency, prevent conflicts, and ensure a smoother
transition we will freeze all AsciiDoc changes.

This means you will get a warning when you create AsciiDoc changes in
your PRs.

   See elastic/docs-builder#281 for details

If there are any questions, please reach out to the
@elastic/docs-engineering

---------

Co-authored-by: Brandon Morelli <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation packaging, ci/cd.
Projects
None yet
Development

No branches or pull requests

3 participants