From ba93b454cd7766aa9558ebeb4bec10448af04389 Mon Sep 17 00:00:00 2001 From: Pier-Hugues Pellerin Date: Wed, 18 Nov 2020 11:13:32 -0500 Subject: [PATCH] Add initial automation rules based on the rules from the beats repository. --- .github/CODEOWNERS | 3 + .github/ISSUE_TEMPLATE.md | 20 ++++++ .github/ISSUE_TEMPLATE/bug-report.md | 20 ++++++ .github/ISSUE_TEMPLATE/feature-request.md | 10 +++ .github/ISSUE_TEMPLATE/flaky-test.md | 19 ++++++ .github/ISSUE_TEMPLATE/question.md | 18 +++++ .github/PULL_REQUEST_TEMPLATE.md | 81 ++++++++++++++++++++++ .github/comment.yml | 12 ++++ .github/labels.yml | 5 ++ .github/paths-labeller.yml | 4 ++ .github/relabel.yml | 7 ++ .github/stale.yml | 82 +++++++++++++++++++++++ 12 files changed, 281 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/flaky-test.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/comment.yml create mode 100644 .github/labels.yml create mode 100644 .github/paths-labeller.yml create mode 100644 .github/relabel.yml create mode 100644 .github/stale.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 000000000..f8447a200 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# CI Specific +/.ci/ @elastic/observablt-robots +/Jenkinsfile @elastic/observablt-robots diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..e23de0d9d --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,20 @@ +--- +name: Bug +about: "Report confirmed bugs. For unconfirmed bugs please visit https://discuss.elastic.co/c/beats" + +--- + +Please post all questions and issues on https://discuss.elastic.co/c/beats +before opening a Github Issue. Your questions will reach a wider audience there, +and if we confirm that there is a bug, then you can open a new issue. + +For security vulnerabilities please only send reports to security@elastic.co. +See https://www.elastic.co/community/security for more information. + +Please include configurations and logs if available. + +For confirmed bugs, please report: +- Version: +- Operating System: +- Discuss Forum URL: +- Steps to Reproduce: diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..e23de0d9d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,20 @@ +--- +name: Bug +about: "Report confirmed bugs. For unconfirmed bugs please visit https://discuss.elastic.co/c/beats" + +--- + +Please post all questions and issues on https://discuss.elastic.co/c/beats +before opening a Github Issue. Your questions will reach a wider audience there, +and if we confirm that there is a bug, then you can open a new issue. + +For security vulnerabilities please only send reports to security@elastic.co. +See https://www.elastic.co/community/security for more information. + +Please include configurations and logs if available. + +For confirmed bugs, please report: +- Version: +- Operating System: +- Discuss Forum URL: +- Steps to Reproduce: diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 000000000..63f696fa6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,10 @@ +--- +name: Enhancement request +about: Beats can't do all the things, but maybe it can do your things. + +--- + +**Describe the enhancement:** + +**Describe a specific use case for the enhancement or feature:** + diff --git a/.github/ISSUE_TEMPLATE/flaky-test.md b/.github/ISSUE_TEMPLATE/flaky-test.md new file mode 100644 index 000000000..3a87af964 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/flaky-test.md @@ -0,0 +1,19 @@ +--- +name: Flaky Test +about: Report a flaky test (one that doesn't pass consistently) +labels: flaky-test +--- + +## Flaky Test + +* **Test Name:** Name of the failing test. +* **Link:** Link to file/line number in github. +* **Branch:** Git branch the test was seen in. If a PR, the branch the PR was based off. +* **Artifact Link:** If available, attach the generated zip artifact associated with the stack trace for this failure. +* **Notes:** Additional details about the test. e.g. theory as to failure cause + +### Stack Trace + +``` +paste stack trace here +``` diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 000000000..2d231df29 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,18 @@ +--- +name: Question +about: Who, what, when, where, and how? + +--- + +Hey, stop right there! + +We use GitHub to track feature requests and bug reports. Please do not submit issues for questions about how to use features of Beat, how to set Beats up, best practices, or development related help. + +However, we do want to help! Head on over to our official Beats forums and ask +your questions there. In additional to awesome, knowledgeable community +contributors, core Beats developers are on the forums every single day to help +you out. + +The forums are here: https://discuss.elastic.co/c/beats + +We can't stop you from opening an issue here, but it will likely linger without a response for days or weeks before it is closed and we ask you to join us on the forums instead. Save yourself the time, and ask on the forums today. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..ef4ecda88 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,81 @@ + + +## What does this PR do? + + + +## Why is it important? + + + +## Checklist + + + +- [ ] My code follows the style guidelines of this project +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] I have made corresponding change to the default configuration files +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have added an entry in `CHANGELOG.next.asciidoc` or `CHANGELOG-developer.next.asciidoc`. + +## Author's Checklist + + +- [ ] + +## How to test this PR locally + + + +## Related issues + + +- + +## Use cases + + + +## Screenshots + + + +## Logs + + diff --git a/.github/comment.yml b/.github/comment.yml new file mode 100644 index 000000000..01440dbe8 --- /dev/null +++ b/.github/comment.yml @@ -0,0 +1,12 @@ +--- +issues: + - label: needs_team + comment: | + This issue doesn't have a `Team:` label. + - label: request-discuss + comment: | + Thank you very much for creating this issue. However, we would kindly like to ask you to post all questions and issues on the [Discuss forum](https://discuss.elastic.co/c/beats) first. In addition to awesome, knowledgeable community contributors, core Beats developers are on the forums every single day to help you out as well. So, your questions will reach a wider audience there, and if we confirm that there is a bug, then you can reopen this issue with the new information or open a new one. +pulls: + - label: needs_team + comment: | + This pull request doesn't have a `Team:` label. diff --git a/.github/labels.yml b/.github/labels.yml new file mode 100644 index 000000000..0d5261864 --- /dev/null +++ b/.github/labels.yml @@ -0,0 +1,5 @@ +--- +pulls: + opened: + add: + - needs_team diff --git a/.github/paths-labeller.yml b/.github/paths-labeller.yml new file mode 100644 index 000000000..3da975414 --- /dev/null +++ b/.github/paths-labeller.yml @@ -0,0 +1,4 @@ +--- + - "Team:Automation": + - ".ci/**/*.*" + - "Jenkinsfile" diff --git a/.github/relabel.yml b/.github/relabel.yml new file mode 100644 index 000000000..74c830744 --- /dev/null +++ b/.github/relabel.yml @@ -0,0 +1,7 @@ +--- +issues: + - missingLabel: needs_team + regex: Team:.+ +pulls: + - missingLabel: needs_team + regex: Team:.+ diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 000000000..c0fadc076 --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,82 @@ +# Configuration for probot-stale - https://github.com/probot/stale + +# Number of days of inactivity before an Issue or Pull Request becomes stale +daysUntilStale: 335 + +# Number of days of inactivity before an Issue or Pull Request with the stale label is closed. +# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale. +daysUntilClose: 30 + +# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled) +onlyLabels: [] + +# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable +exemptLabels: [] + +# Set to true to ignore issues in a project (defaults to false) +exemptProjects: true + +# Set to true to ignore issues in a milestone (defaults to false) +exemptMilestones: true + +# Set to true to ignore issues with an assignee (defaults to false) +exemptAssignees: true + +# Label to use when marking as stale +staleLabel: Stalled + +# Comment to post when marking as stale. Set to `false` to disable +markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. Thank you + for your contributions. + +# Comment to post when removing the stale label. +# unmarkComment: > +# Your comment here. + +# Comment to post when closing a stale Issue or Pull Request. +# closeComment: > +# Your comment here. + +# Limit the number of actions per hour, from 1-30. Default is 30 +limitPerRun: 30 + +# Limit to only `issues` or `pulls` +# only: issues + +# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls': +pulls: + daysUntilStale: 30 + daysUntilClose: 30 + markComment: > + Hi! + + We just realized that we haven't looked into this PR in a while. We're + sorry! + + + We're labeling this issue as `Stale` to make it hit our filters and + make sure we get back to it in as soon as possible. In the meantime, it'd + be extremely helpful if you could take a look at it as well and confirm its + relevance. A simple comment with a nice emoji will be enough `:+1`. + + Thank you for your contribution! + + closeComment: > + Hi! + + This PR has been stale for a while and we're going to close it as part of + our cleanup procedure. + + We appreciate your contribution and would like to apologize if we have not + been able to review it, due to the current heavy load of the team. + + Feel free to re-open this PR if you think it should stay open and is worth rebasing. + + Thank you for your contribution! + + +# issues: +# exemptLabels: +# - confirmed \ No newline at end of file