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

Buildkite PR job - batch2 #2848

Merged
merged 2 commits into from
Dec 7, 2023
Merged

Buildkite PR job - batch2 #2848

merged 2 commits into from
Dec 7, 2023

Conversation

nkammah
Copy link
Contributor

@nkammah nkammah commented Dec 1, 2023

This PR adds a few more repositories to the Buildkite job rollout - see comm email about it.

Note to reviewers (ideally doc point persons):

1. Validate the build avoidance logic (if applicable)

The Buildkite PR bot has some build avoidance logic in place. Some repositories are configured to have the docs PR job for any changes in the repo. Other are configured for changes in the "docs" folder only.. I tried to follow the docs script build avoidance logic to determine how the repo should be configured, but you need to validate that this is actually the case.

Repos configured to trigger PR on every changes

Repos configured to trigger PR on changes in the docs folder only

2. Setup or update your GH action

As mentioned in the comm email, you can setup a GitHub action that posts a comment with various links to validate the doc
image

Here's an example setup you can copy in your repo.

3. Assess if you anticipate potential conflicts with other Buildkite pipelines in your repository

The docs PR job leverages the Buildkite PR bot. Before merging this PR, I will setup a webhook in your repository (following the instructions here). The config used for the PR job lives in the docs repo in the ./buildkite/pull-requests.org-wide.json file. There should not be any conflicts with your current jobs, but I like to be overly explicit with it.

4. What to expect once this is setup?

The Buildkite PR jobs are non-blocking at this time - but we need your help validating that they produce the same results than in Jenkins - see comm.

The below options are supported to trigger the docs builds:

run docs-build
run docs-build rebuild
run docs-build warnlinkcheck
run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option)
buildkite test this
buildkite test this rebuild
buildkite test this warnlinkcheck
buildkite test this skiplinkcheck (takes precedence over the warnlinkcheck option)

CC - @robbavey @dliappis on the new Buildkite jobs for logstash

Copy link

github-actions bot commented Dec 1, 2023

A documentation preview will be available soon.
Help us out by validating the Buildkite preview and reporting issues here.

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

It seems that we're seeing some side effects from the previous PR: #2837. Let's check that out, please, before we merge another batch. Otherwise, what I'm seeing here for logstash looks good and makes sense.

@nkammah
Copy link
Contributor Author

nkammah commented Dec 5, 2023

@karenzone - indeed, as explained in https://github.com/elastic/ingest-dev/issues/2703#issuecomment-1838132700, until yesterday, two commits happening close to each other against the same doc PR could run concurrently and cause git issues - I responded to the issue reported with concurrent builds on the same PR. This has been fixed here and it seems to work -eg. the below 3 builds were all for this PR - the first 2 got canceled and the last one ran successfully:

image image

@nkammah nkammah merged commit f1c1b67 into master Dec 7, 2023
7 checks passed
@nkammah nkammah deleted the buildkite-pr-batch2 branch December 7, 2023 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants