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

Remove API doc workflow, add codeowners #188169

Merged
merged 9 commits into from
Jul 17, 2024
Merged

Remove API doc workflow, add codeowners #188169

merged 9 commits into from
Jul 17, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 11, 2024

Summary

Relates to #186909

This PR:

  • Removes the bump.yml workflow until we can determine a better solution
  • Makes the platform docs team codeowners for the files related to the manually maintained OpenAPI documents

@obltmachine
Copy link

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl marked this pull request as ready for review July 15, 2024 16:56
@lcawl lcawl requested a review from a team as a code owner July 15, 2024 16:56
@lcawl lcawl added Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting labels Jul 15, 2024
@lcawl lcawl added v8.15.0 v8.16.0 and removed backport:skip This commit does not require backporting labels Jul 15, 2024
@jbudz jbudz requested a review from a team July 16, 2024 12:47
@DaveSys911
Copy link

@jbudz I would also double check the repo settings for https://docs.github.com/en/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks#about-workflow-runs-from-public-forks.

That way any invocation by an external contributor would require input from a maintainer.

uses: bump-sh/github-action@v1
with:
doc: serverless
token: ${{secrets.BUMP_TOKEN}}

Choose a reason for hiding this comment

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

@lcawl I believe this would fail when ran from forks. Since it won't have access to the secret.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since this PR doesn't seem to solve the problem, I've changed it to remove the existing problematic workflow instead.

@elasticmachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

@lcawl lcawl changed the title Split API doc workflows Remove API doc workflow, add codeowners Jul 17, 2024
@jeramysoucy jeramysoucy self-requested a review July 17, 2024 18:50
@lcawl lcawl merged commit 1a1c7d6 into elastic:main Jul 17, 2024
20 checks passed
@lcawl lcawl deleted the bump-action branch July 17, 2024 21:21
@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
8.15 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.15:
- [Security Assistant] Updates ESQL example queries used in ESQL Query Generation (#188492)
- [data view] Data view management - persist count / popularity number (#188285)

Manual backport

To create the backport manually run:

node scripts/backport --pr 188169

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Jul 17, 2024
@lcawl
Copy link
Contributor Author

lcawl commented Jul 17, 2024

💚 All backports created successfully

Status Branch Result
8.15

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Jul 17, 2024
# Backport

This will backport the following commits from `main` to `8.15`:
- [Remove API doc workflow, add codeowners
(#188169)](#188169)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-07-17T21:21:12Z","message":"Remove
API doc workflow, add codeowners (#188169)\n\n\r\nCo-authored-by: Jon
<[email protected]>","sha":"1a1c7d6101b32f9e84fbb39d7f10e0dcb1303ad5","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v8.15.0","Feature:OAS","v8.16.0"],"number":188169,"url":"https://github.com/elastic/kibana/pull/188169","mergeCommit":{"message":"Remove
API doc workflow, add codeowners (#188169)\n\n\r\nCo-authored-by: Jon
<[email protected]>","sha":"1a1c7d6101b32f9e84fbb39d7f10e0dcb1303ad5"}},"sourceBranch":"main","suggestedTargetBranches":["8.15"],"targetPullRequestStates":[{"branch":"8.15","label":"v8.15.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/188169","number":188169,"mergeCommit":{"message":"Remove
API doc workflow, add codeowners (#188169)\n\n\r\nCo-authored-by: Jon
<[email protected]>","sha":"1a1c7d6101b32f9e84fbb39d7f10e0dcb1303ad5"}}]}]
BACKPORT-->
@jeramysoucy jeramysoucy removed their request for review July 17, 2024 23:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS release_note:skip Skip the PR/issue when compiling release notes v8.15.0 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants