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

github-actions: update command to run the docs validation #181943

Merged
merged 1 commit into from
Apr 29, 2024

Conversation

v1v
Copy link
Member

@v1v v1v commented Apr 29, 2024

Summary

Update the comment with how to run the docs validation

Checklist

Delete any items that are not applicable to this PR.

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk Probability Severity Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space. Low High Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. High Low Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled. Medium High Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

@v1v v1v added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting skip-ci labels Apr 29, 2024
@v1v v1v self-assigned this Apr 29, 2024
@v1v v1v requested a review from a team as a code owner April 29, 2024 08:00
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

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

@v1v v1v merged commit 9035166 into elastic:main Apr 29, 2024
13 checks passed
@v1v v1v deleted the feature/update-docs-comment branch April 29, 2024 13:28
@@ -50,8 +50,7 @@ jobs:

Just comment with:
- \`/oblt-deploy\` : Deploy a Kibana instance using the Observability test environments.
- \`run\` \`elasticsearch-ci/docs\` : Re-trigger the docs validation. (use unformatted text in the comment!)

- \`run\` \`docs-build\` : Re-trigger the docs validation. (use unformatted text in the comment!)
Copy link
Member

@sorenlouv sorenlouv May 1, 2024

Choose a reason for hiding this comment

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

@v1v Is this two separate commands or one? As in, there is run and then there is docs-build? If not I suggest it formatted as a single command run docs-build

Copy link
Member Author

Choose a reason for hiding this comment

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

Is this two separate commands or one?

one, run docs-build is the command.

If the message is not clear please let me know and we can change the content to be more accurate. I split with special chars so it avoids the recurrence of being detected as run docs-build by the CI docs pipeline

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes skip-ci v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants