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

Allow members of @security-solution-test-skippers to use /skip comments on failed test issues #173430

Conversation

oatkiller
Copy link
Contributor

@oatkiller oatkiller commented Dec 14, 2023

Summary

After a PR is merged, CI runs all the tests on main. If one fails, a github issue with the label failed-test is created. If you comment /skip on the issue then a workflow action will skip the test directly on the failing branches.

This workflow can only be used by contributors who have admin access to Kibana, OR to people who are on an allow-list of elastic teams. The list of teams allowed is appex-qa.

This PR adds another team to the list: @elastic/security-solution-test-skippers
This team was just created to allow a small list of Security Solution contributors the ability to use this workflow.

Allowing a few of us access to this workflow will allow Security to triage our own test by writing /skip comments.

Without this PR we have to:

Without this PR we have to do a bunch of stuff to skip our own flaky tests:

  1. Manually edit the files to create a PR on all affected branches.
  2. Create PRs using the web app.
  3. Get a second developer to approve the PR.
  4. Wait for CI.
  5. Merge the PR.

This process is slow because of manual steps, and because CI must run before we can skip the test. At a minimum we should expect that process to take as long as CI takes (e.g. 90 minutes.) But the PRs that are meant to skip tests may also in turn be blocked by flaky tests. It also requires coordination from 2 people to make and approve the PR.

Code references

skip-failed-test.yml is where the workflow is defined

Docs on the syntax for workflows.

permission-check/index.ts is where the permission check is implemented. Users need to have:

  • either the right permission level
  • or be a member of the team

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

@MadameSheema MadameSheema added Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.12.0 v8.13.0 release_note:skip Skip the PR/issue when compiling release notes labels Dec 18, 2023
@MadameSheema MadameSheema marked this pull request as ready for review December 18, 2023 09:14
@MadameSheema MadameSheema requested a review from a team as a code owner December 18, 2023 09:14
Copy link
Contributor

@watson watson left a comment

Choose a reason for hiding this comment

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

Approving based on Slack discussion in #kibana-operations channel

@MadameSheema MadameSheema enabled auto-merge (squash) December 19, 2023 09:45
Copy link
Member

@mistic mistic left a comment

Choose a reason for hiding this comment

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

approving temporarily until the end of Jan 2024 as discussed in the slack thread :)

@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.12

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

Questions ?

Please refer to the Backport tool documentation

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 19, 2023
…ents on failed test issues (elastic#173430)

## Summary

After a PR is merged, CI runs all the tests on `main`. If one fails, a
github issue with the label `failed-test` is created. If you comment
`/skip` on the issue then a workflow action will skip the test directly
on the failing branches.

This workflow can only be used by contributors who have `admin` access
to Kibana, OR to people who are on an allow-list of elastic teams. The
list of teams allowed is `appex-qa`.

This PR adds another team to the list:
@elastic/security-solution-test-skippers
This team was just created to allow a small list of Security Solution
contributors the ability to use this workflow.

Allowing a few of us access to this workflow will allow Security to
triage our own test by writing `/skip` comments.

### Without this PR we have to:

Without this PR we have to do a bunch of stuff to skip our own flaky
tests:

1. Manually edit the files to create a PR on all affected branches.
2. Create PRs using the web app.
3. Get a second developer to approve the PR.
4. Wait for CI.
5. Merge the PR.

This process is slow because of manual steps, and because CI must run
before we can skip the test. At a minimum we should expect that process
to take as long as CI takes (e.g. 90 minutes.) But the PRs that are
meant to skip tests may also in turn be blocked by flaky tests. It also
requires coordination from 2 people to make and approve the PR.

### Code references

[skip-failed-test.yml](https://github.com/elastic/kibana/blob/main/.github/workflows/skip-failed-test.yml#L25-L30)
is where the workflow is defined

[Docs on the syntax for
workflows.](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses)

[permission-check/index.ts](https://github.com/elastic/kibana-github-actions/blob/main/permission-check/index.ts#L23-L26)
is where the permission check is implemented. Users need to have:
* either the right permission level
* or be a member of the team

### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

### 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](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |

### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

Co-authored-by: Gloria Hornero <[email protected]>
(cherry picked from commit dd765ab)
kibanamachine added a commit that referenced this pull request Dec 19, 2023
…p` comments on failed test issues (#173430) (#173687)

# Backport

This will backport the following commits from `main` to `8.12`:
- [Allow members of @security-solution-test-skippers to use `/skip`
comments on failed test issues
(#173430)](#173430)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"Robert
Austin","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-12-19T19:13:12Z","message":"Allow
members of @security-solution-test-skippers to use `/skip` comments on
failed test issues (#173430)\n\n## Summary\r\n\r\nAfter a PR is merged,
CI runs all the tests on `main`. If one fails, a\r\ngithub issue with
the label `failed-test` is created. If you comment\r\n`/skip` on the
issue then a workflow action will skip the test directly\r\non the
failing branches.\r\n\r\nThis workflow can only be used by contributors
who have `admin` access\r\nto Kibana, OR to people who are on an
allow-list of elastic teams. The\r\nlist of teams allowed is
`appex-qa`.\r\n\r\nThis PR adds another team to the
list:\r\n@elastic/security-solution-test-skippers\r\nThis team was just
created to allow a small list of Security Solution\r\ncontributors the
ability to use this workflow.\r\n\r\nAllowing a few of us access to this
workflow will allow Security to\r\ntriage our own test by writing
`/skip` comments.\r\n\r\n### Without this PR we have to:\r\n\r\nWithout
this PR we have to do a bunch of stuff to skip our own
flaky\r\ntests:\r\n\r\n1. Manually edit the files to create a PR on all
affected branches.\r\n2. Create PRs using the web app.\r\n3. Get a
second developer to approve the PR.\r\n4. Wait for CI.\r\n5. Merge the
PR.\r\n\r\nThis process is slow because of manual steps, and because CI
must run\r\nbefore we can skip the test. At a minimum we should expect
that process\r\nto take as long as CI takes (e.g. 90 minutes.) But the
PRs that are\r\nmeant to skip tests may also in turn be blocked by flaky
tests. It also\r\nrequires coordination from 2 people to make and
approve the PR.\r\n\r\n### Code
references\r\n\r\n\r\n[skip-failed-test.yml](https://github.com/elastic/kibana/blob/main/.github/workflows/skip-failed-test.yml#L25-L30)\r\nis
where the workflow is defined\r\n\r\n[Docs on the syntax
for\r\nworkflows.](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses)\r\n\r\n\r\n[permission-check/index.ts](https://github.com/elastic/kibana-github-actions/blob/main/permission-check/index.ts#L23-L26)\r\nis
where the permission check is implemented. Users need to have:\r\n*
either the right permission level\r\n* or be a member of the
team\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [ ] Any UI touched in this PR is
usable by keyboard only (learn more\r\nabout [keyboard
accessibility](https://webaim.org/techniques/keyboard/))\r\n- [ ] Any UI
touched in this PR does not create any new axe failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[ ] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[ ] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n###
Risk Matrix\r\n\r\nDelete this section if it is not applicable to this
PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other
developers to\r\nidentify risks that should be tested prior to the
change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider
some of the following examples\r\nand how they may potentially impact
the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes
|\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n|
Multiple Spaces&mdash;unexpected behavior in non-default Kibana
Space.\r\n| Low | High | Integration tests will verify that all features
are still\r\nsupported in non-default Kibana Space and when user
switches between\r\nspaces. |\r\n| Multiple nodes&mdash;Elasticsearch
polling might have race conditions\r\nwhen multiple Kibana nodes are
polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so
executing them multiple times will not result\r\nin logical error, but
will degrade performance. To test for this case we\r\nadd plenty of unit
tests around this logic and document manual testing\r\nprocedure. |\r\n|
Code should gracefully handle cases when feature X or plugin Y
are\r\ndisabled. | Medium | High | Unit tests will verify that any
feature flag\r\nor plugin combination still results in our service
operational. |\r\n| [See more potential
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
|\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for
breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\nCo-authored-by:
Gloria Hornero
<[email protected]>","sha":"dd765ab84c98ddd823dc48152c36bc7ee6a1bd81","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:
SecuritySolution","v8.12.0","v8.13.0"],"number":173430,"url":"https://github.com/elastic/kibana/pull/173430","mergeCommit":{"message":"Allow
members of @security-solution-test-skippers to use `/skip` comments on
failed test issues (#173430)\n\n## Summary\r\n\r\nAfter a PR is merged,
CI runs all the tests on `main`. If one fails, a\r\ngithub issue with
the label `failed-test` is created. If you comment\r\n`/skip` on the
issue then a workflow action will skip the test directly\r\non the
failing branches.\r\n\r\nThis workflow can only be used by contributors
who have `admin` access\r\nto Kibana, OR to people who are on an
allow-list of elastic teams. The\r\nlist of teams allowed is
`appex-qa`.\r\n\r\nThis PR adds another team to the
list:\r\n@elastic/security-solution-test-skippers\r\nThis team was just
created to allow a small list of Security Solution\r\ncontributors the
ability to use this workflow.\r\n\r\nAllowing a few of us access to this
workflow will allow Security to\r\ntriage our own test by writing
`/skip` comments.\r\n\r\n### Without this PR we have to:\r\n\r\nWithout
this PR we have to do a bunch of stuff to skip our own
flaky\r\ntests:\r\n\r\n1. Manually edit the files to create a PR on all
affected branches.\r\n2. Create PRs using the web app.\r\n3. Get a
second developer to approve the PR.\r\n4. Wait for CI.\r\n5. Merge the
PR.\r\n\r\nThis process is slow because of manual steps, and because CI
must run\r\nbefore we can skip the test. At a minimum we should expect
that process\r\nto take as long as CI takes (e.g. 90 minutes.) But the
PRs that are\r\nmeant to skip tests may also in turn be blocked by flaky
tests. It also\r\nrequires coordination from 2 people to make and
approve the PR.\r\n\r\n### Code
references\r\n\r\n\r\n[skip-failed-test.yml](https://github.com/elastic/kibana/blob/main/.github/workflows/skip-failed-test.yml#L25-L30)\r\nis
where the workflow is defined\r\n\r\n[Docs on the syntax
for\r\nworkflows.](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses)\r\n\r\n\r\n[permission-check/index.ts](https://github.com/elastic/kibana-github-actions/blob/main/permission-check/index.ts#L23-L26)\r\nis
where the permission check is implemented. Users need to have:\r\n*
either the right permission level\r\n* or be a member of the
team\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [ ] Any UI touched in this PR is
usable by keyboard only (learn more\r\nabout [keyboard
accessibility](https://webaim.org/techniques/keyboard/))\r\n- [ ] Any UI
touched in this PR does not create any new axe failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[ ] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[ ] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n###
Risk Matrix\r\n\r\nDelete this section if it is not applicable to this
PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other
developers to\r\nidentify risks that should be tested prior to the
change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider
some of the following examples\r\nand how they may potentially impact
the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes
|\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n|
Multiple Spaces&mdash;unexpected behavior in non-default Kibana
Space.\r\n| Low | High | Integration tests will verify that all features
are still\r\nsupported in non-default Kibana Space and when user
switches between\r\nspaces. |\r\n| Multiple nodes&mdash;Elasticsearch
polling might have race conditions\r\nwhen multiple Kibana nodes are
polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so
executing them multiple times will not result\r\nin logical error, but
will degrade performance. To test for this case we\r\nadd plenty of unit
tests around this logic and document manual testing\r\nprocedure. |\r\n|
Code should gracefully handle cases when feature X or plugin Y
are\r\ndisabled. | Medium | High | Unit tests will verify that any
feature flag\r\nor plugin combination still results in our service
operational. |\r\n| [See more potential
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
|\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for
breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\nCo-authored-by:
Gloria Hornero
<[email protected]>","sha":"dd765ab84c98ddd823dc48152c36bc7ee6a1bd81"}},"sourceBranch":"main","suggestedTargetBranches":["8.12"],"targetPullRequestStates":[{"branch":"8.12","label":"v8.12.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.13.0","labelRegex":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/173430","number":173430,"mergeCommit":{"message":"Allow
members of @security-solution-test-skippers to use `/skip` comments on
failed test issues (#173430)\n\n## Summary\r\n\r\nAfter a PR is merged,
CI runs all the tests on `main`. If one fails, a\r\ngithub issue with
the label `failed-test` is created. If you comment\r\n`/skip` on the
issue then a workflow action will skip the test directly\r\non the
failing branches.\r\n\r\nThis workflow can only be used by contributors
who have `admin` access\r\nto Kibana, OR to people who are on an
allow-list of elastic teams. The\r\nlist of teams allowed is
`appex-qa`.\r\n\r\nThis PR adds another team to the
list:\r\n@elastic/security-solution-test-skippers\r\nThis team was just
created to allow a small list of Security Solution\r\ncontributors the
ability to use this workflow.\r\n\r\nAllowing a few of us access to this
workflow will allow Security to\r\ntriage our own test by writing
`/skip` comments.\r\n\r\n### Without this PR we have to:\r\n\r\nWithout
this PR we have to do a bunch of stuff to skip our own
flaky\r\ntests:\r\n\r\n1. Manually edit the files to create a PR on all
affected branches.\r\n2. Create PRs using the web app.\r\n3. Get a
second developer to approve the PR.\r\n4. Wait for CI.\r\n5. Merge the
PR.\r\n\r\nThis process is slow because of manual steps, and because CI
must run\r\nbefore we can skip the test. At a minimum we should expect
that process\r\nto take as long as CI takes (e.g. 90 minutes.) But the
PRs that are\r\nmeant to skip tests may also in turn be blocked by flaky
tests. It also\r\nrequires coordination from 2 people to make and
approve the PR.\r\n\r\n### Code
references\r\n\r\n\r\n[skip-failed-test.yml](https://github.com/elastic/kibana/blob/main/.github/workflows/skip-failed-test.yml#L25-L30)\r\nis
where the workflow is defined\r\n\r\n[Docs on the syntax
for\r\nworkflows.](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses)\r\n\r\n\r\n[permission-check/index.ts](https://github.com/elastic/kibana-github-actions/blob/main/permission-check/index.ts#L23-L26)\r\nis
where the permission check is implemented. Users need to have:\r\n*
either the right permission level\r\n* or be a member of the
team\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [ ] Any UI touched in this PR is
usable by keyboard only (learn more\r\nabout [keyboard
accessibility](https://webaim.org/techniques/keyboard/))\r\n- [ ] Any UI
touched in this PR does not create any new axe failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[ ] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[ ] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n###
Risk Matrix\r\n\r\nDelete this section if it is not applicable to this
PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other
developers to\r\nidentify risks that should be tested prior to the
change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider
some of the following examples\r\nand how they may potentially impact
the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes
|\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n|
Multiple Spaces&mdash;unexpected behavior in non-default Kibana
Space.\r\n| Low | High | Integration tests will verify that all features
are still\r\nsupported in non-default Kibana Space and when user
switches between\r\nspaces. |\r\n| Multiple nodes&mdash;Elasticsearch
polling might have race conditions\r\nwhen multiple Kibana nodes are
polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so
executing them multiple times will not result\r\nin logical error, but
will degrade performance. To test for this case we\r\nadd plenty of unit
tests around this logic and document manual testing\r\nprocedure. |\r\n|
Code should gracefully handle cases when feature X or plugin Y
are\r\ndisabled. | Medium | High | Unit tests will verify that any
feature flag\r\nor plugin combination still results in our service
operational. |\r\n| [See more potential
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
|\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for
breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\nCo-authored-by:
Gloria Hornero
<[email protected]>","sha":"dd765ab84c98ddd823dc48152c36bc7ee6a1bd81"}}]}]
BACKPORT-->

Co-authored-by: Robert Austin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.12.0 v8.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants