diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-07-19 15:09:29 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-07-19 15:09:29 +0300 |
| commit | 3ca9a972f6bc4060a58703398df74d87703916cf (patch) | |
| tree | 4c10ba27bd3e079ad156f030835179a6dd4dafa8 /tooling | |
| parent | 76e68e67ab3e928d289361ac20558a053a623263 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'tooling')
| -rw-r--r-- | tooling/danger/specs/project_factory_suggestion.rb | 13 | ||||
| -rw-r--r-- | tooling/graphql/docs/templates/default.md.haml | 2 |
2 files changed, 7 insertions, 8 deletions
diff --git a/tooling/danger/specs/project_factory_suggestion.rb b/tooling/danger/specs/project_factory_suggestion.rb index 78230db9585..8f9a05a0aba 100644 --- a/tooling/danger/specs/project_factory_suggestion.rb +++ b/tooling/danger/specs/project_factory_suggestion.rb @@ -28,17 +28,16 @@ module Tooling REPLACEMENT = '\k<head>let_it_be\k<tail>' SUGGESTION = <<~SUGGEST_COMMENT - Project creations are very slow. Using `let_it_be`, `build` or `build_stubbed` can improve test performance. + Project creations are very slow. To improve test performance, consider using `let_it_be`, `build`, or `build_stubbed` instead. - Warning: `let_it_be` may not be suitable if your test modifies data as this could result in state leaks! + ⚠️ **Warning**: If your test modifies data, `let_it_be` may be unsuitable, and cause state leaks! Use `let_it_be_with_reload` or `let_it_be_with_refind` instead. - In those cases, please use `let_it_be_with_reload` or `let_it_be_with_refind` instead. - - If your are unsure which is the right method to use, - please refer to [testing best practices](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#optimize-factory-usage) + Unsure which method to use? See the [testing best practices](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#optimize-factory-usage) for background information and alternative options for optimizing factory usage. - Feel free to ignore this comment if you know `let` or `let!` are the better options and/or worry about causing state leaks. + If you're concerned about causing state leaks, or if you know `let` or `let!` are the better options, ignore this comment. + + ([Improve this message?](https://gitlab.com/gitlab-org/gitlab/-/blob/master/tooling/danger/specs/project_factory_suggestion.rb)) SUGGEST_COMMENT end end diff --git a/tooling/graphql/docs/templates/default.md.haml b/tooling/graphql/docs/templates/default.md.haml index fad954ebb01..57c3ca7a476 100644 --- a/tooling/graphql/docs/templates/default.md.haml +++ b/tooling/graphql/docs/templates/default.md.haml @@ -3,7 +3,7 @@ = auto_generated_comment :plain - # GraphQL API Resources + # GraphQL API resources This documentation is self-generated based on GitLab current GraphQL schema. |