github-action: Add AsciiDoc freeze warning#208534
Conversation
|
I see this is going to ask authors not to merge. We regularly have asciidoc updates paired with source changes. Is there anything we can communicate to authors that are blocked from implementing bug fixes and feature work? I see the migration guide, but don't see anything actionable yet. |
|
This process is non-blocking by design. Authors can still merge PRs during the documentation freeze. However, it’s important to note that any changes made to AsciiDoc documentation files after January 29 will be lost. We do not have a way to preserve documentation changes until content is fully migrated to the new file structure and build system. Content changes can resume according to the timeline communicated here. |
Is it possible to note something to this effect in the comment? It looks like it's just asking authors not to merge the change currently. |
|
Yes, that's good feedback. I will update the text. |
|
Updated the comment and added a bunch of additional context to the link destination. Thanks again for the feedback. |
jbudz
left a comment
There was a problem hiding this comment.
Added a few comments, but don't want to get in the way of scheduling.
Circling back if needed works for me.
| - main | ||
| - master | ||
| - "9.0" |
There was a problem hiding this comment.
| - main | |
| - master | |
| - "9.0" | |
| - main |
There was a problem hiding this comment.
Will 9.0 be created today?
| name: Comment on PR for .asciidoc changes | ||
|
|
||
| on: | ||
| pull_request: |
There was a problem hiding this comment.
Did we consider using paths? The checkout is taking ~5 minutes currently
on:
pull_request:
branches:
- main
paths:
- 'docs/**.asciidoc'
There was a problem hiding this comment.
Thank you for the suggestion.
I changed the implementation to use an existing action which does not depend on fetch-depth: 0.
Hence, I think, the checkout time should decrease.
| on: | ||
| pull_request: | ||
| types: | ||
| - synchronize |
There was a problem hiding this comment.
This may end up leaving quite a few duplicate comments. I'm assuming it's to catch already open pull requests, but wanted to make a note.
Details
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