Skip to content

[OpenAPI] Add redocly lint configuration#199360

Merged
lcawl merged 8 commits intoelastic:mainfrom
lcawl:oas-lint
Nov 8, 2024
Merged

[OpenAPI] Add redocly lint configuration#199360
lcawl merged 8 commits intoelastic:mainfrom
lcawl:oas-lint

Conversation

@lcawl
Copy link
Copy Markdown
Member

@lcawl lcawl commented Nov 7, 2024

Summary

Relates to #197482

This PR updates the OpenAPI lint commands to use Redocly lint instead of Spectral.

I've used some built-in rules and one configurable rule. We can add more of the latter in subsequent PRs to match what we had done in Spectral.

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS v8.16.0 backport:version Backport to applied version labels v8.17.0 labels Nov 7, 2024
@lcawl lcawl requested a review from jloleysens November 7, 2024 18:24
@lcawl lcawl marked this pull request as ready for review November 7, 2024 18:24
@lcawl lcawl requested a review from a team as a code owner November 7, 2024 18:24
@lcawl lcawl enabled auto-merge (squash) November 8, 2024 18:20
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Nov 8, 2024

💔 Build Failed

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #40 / @ess @serverless SecuritySolution Explore Overview Overview Network With packetbeat Make sure that we get OverviewNetwork data
  • [job] [logs] FTR Configs #40 / @ess @serverless SecuritySolution Explore Overview Overview Network With packetbeat Make sure that we get OverviewNetwork data
  • [job] [logs] FTR Configs #32 / New terms rule execution logic API @ess @serverless New terms type rules, alert suppression deduplicates new alerts if they were previously created without suppression

Metrics [docs]

✅ unchanged

History

@lcawl lcawl merged commit 907d19b into elastic:main Nov 8, 2024
@kibanamachine
Copy link
Copy Markdown
Contributor

Starting backport for target branches: 8.16, 8.x

https://github.com/elastic/kibana/actions/runs/11748840877

@lcawl lcawl deleted the oas-lint branch November 8, 2024 20:08
@kibanamachine
Copy link
Copy Markdown
Contributor

💔 All backports failed

Status Branch Result
8.16 Backport failed because of merge conflicts
8.x Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 199360

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Nov 8, 2024
(cherry picked from commit 907d19b)

# Conflicts:
#	oas_docs/makefile
lcawl added a commit to lcawl/kibana that referenced this pull request Nov 8, 2024
@lcawl
Copy link
Copy Markdown
Member Author

lcawl commented Nov 8, 2024

💚 All backports created successfully

Status Branch Result
8.x
8.16

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 Nov 8, 2024
# Backport

This will backport the following commits from `main` to `8.x`:
- [[OpenAPI] Add redocly lint configuration
(#199360)](#199360)

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

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-11-08T20:07:55Z","message":"[OpenAPI]
Add redocly lint configuration
(#199360)","sha":"907d19b7b82598ab070901f772323b71b583bc65","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Feature:OAS","v8.16.0","backport:version","v8.17.0"],"number":199360,"url":"https://github.com/elastic/kibana/pull/199360","mergeCommit":{"message":"[OpenAPI]
Add redocly lint configuration
(#199360)","sha":"907d19b7b82598ab070901f772323b71b583bc65"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199360","number":199360,"mergeCommit":{"message":"[OpenAPI]
Add redocly lint configuration
(#199360)","sha":"907d19b7b82598ab070901f772323b71b583bc65"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
lcawl added a commit that referenced this pull request Nov 9, 2024
# Backport

This will backport the following commits from `main` to `8.16`:
- [[OpenAPI] Add redocly lint configuration
(#199360)](#199360)

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

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-11-08T20:07:55Z","message":"[OpenAPI]
Add redocly lint configuration
(#199360)","sha":"907d19b7b82598ab070901f772323b71b583bc65","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Feature:OAS","v8.16.0","backport:version","v8.17.0"],"number":199360,"url":"https://github.com/elastic/kibana/pull/199360","mergeCommit":{"message":"[OpenAPI]
Add redocly lint configuration
(#199360)","sha":"907d19b7b82598ab070901f772323b71b583bc65"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199360","number":199360,"mergeCommit":{"message":"[OpenAPI]
Add redocly lint configuration
(#199360)","sha":"907d19b7b82598ab070901f772323b71b583bc65"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

NOTE: I've also removed the serverless commands from the makefile, since
they're not relevant to this branch.

This PR will encounter CI failures until
#199571 is merged.
@mistic
Copy link
Copy Markdown
Contributor

mistic commented Nov 12, 2024

This PR didn't make it on time to the latest 8.16.0 BC. Updating the labels.

@mistic mistic added v8.16.1 and removed v8.16.0 labels Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:version Backport to applied version 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.16.1 v8.17.0 v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants