Skip to content

Add info comment to preview build #1667

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

reakaleek
Copy link
Member

@reakaleek reakaleek commented Aug 1, 2025

Context

As an attempt to centralize elastic/elasticsearch#132257

Changes

Add a step to the preview build that comments about versioning.

Usage

name: docs-build

on:
  push:
    branches:
      - main
  pull_request_target: ~
  merge_group: ~

jobs:
  docs-preview:
    uses: elastic/docs-builder/.github/workflows/preview-build.yml@main
    with:
      path-pattern: docs/**
      path-pattern-ignore: docs/changelog/**/*.yaml
+     enable-cumulative-comment: true
    permissions:
      deployments: write
      id-token: write
      contents: read
      pull-requests: write

@reakaleek reakaleek requested a review from a team as a code owner August 1, 2025 12:11
@reakaleek reakaleek self-assigned this Aug 1, 2025
@reakaleek reakaleek added the automation packaging, ci/cd. label Aug 1, 2025
@reakaleek reakaleek requested a review from leemthompo August 1, 2025 12:11
Copy link
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

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

It'd be nice if we can rename disable-comments to disable-changes-comment, might be hard unless we support both for a while.

@reakaleek reakaleek requested a review from Mpdreamz August 4, 2025 19:57
@@ -438,3 +444,58 @@ jobs:
body:body.join('\n'),
});
}
- name: Comment on docs changes about versioning requirements
if: inputs.enable-cumulative-comment == 'true'
Copy link
Member

Choose a reason for hiding this comment

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

We need to check for any_modified files in order to not always comment on all PR's even without doc changes if enabled.

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

Successfully merging this pull request may close these issues.

2 participants