generated from honeycombio/.github
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b198ba9
Showing
20 changed files
with
484 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Code owners file. | ||
# This file controls who is tagged for review for any given pull request. | ||
|
||
# For anything not explicitly taken by someone else: | ||
* @honeycombio/telemetry-team | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Bug report | ||
about: Let us know if something is not working as expected | ||
title: '' | ||
labels: 'type: bug' | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!--- | ||
Thank you for taking the time to report bugs! | ||
We love code snippets and links to repositories that reproduce the issue, but understand if you don't have the time to add them. We'll do our best with the info you provide, and might ask follow-up questions. | ||
Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate. | ||
---> | ||
|
||
**Versions** | ||
|
||
|
||
**Steps to reproduce** | ||
|
||
1. | ||
|
||
**Additional context** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: 'type: enhancement' | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!--- | ||
Thank you for contributing an idea to this project! | ||
Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate. | ||
---> | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
|
||
|
||
**Describe the solution you'd like** | ||
|
||
|
||
**Describe alternatives you've considered** | ||
|
||
|
||
**Additional context** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
name: Question/Discussion | ||
about: General question about how things work or a discussion | ||
title: '' | ||
labels: 'type: discussion' | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!--- | ||
Thank you for taking the time to say hello! | ||
Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate. | ||
---> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: Security vulnerability report | ||
about: Let us know if you discover a security vulnerability | ||
title: '' | ||
labels: 'type: security' | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!--- | ||
Thank you for taking the time to report security vulnerabilities! | ||
Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate. | ||
---> | ||
**Versions** | ||
|
||
**Description** | ||
|
||
(Please include any relevant CVE advisory links) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<!-- | ||
Thank you for contributing to the project! 💜 | ||
Please see our [OSS process document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#) to get an idea of how we operate. | ||
--> | ||
|
||
## Which problem is this PR solving? | ||
|
||
- Closes #<enter issue here> | ||
|
||
## Short description of the changes | ||
|
||
## How to verify that this has the expected result |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# .github/release.yml | ||
|
||
changelog: | ||
exclude: | ||
labels: | ||
- no-changelog | ||
categories: | ||
- title: 💥 Breaking Changes 💥 | ||
labels: | ||
- "version: bump major" | ||
- breaking-change | ||
- title: 💡 Enhancements | ||
labels: | ||
- "type: enhancement" | ||
- title: 🐛 Fixes | ||
labels: | ||
- "type: bug" | ||
- title: 🛠 Maintenance | ||
labels: | ||
- "type: maintenance" | ||
- "type: dependencies" | ||
- "type: documentation" | ||
- title: 🤷 Other Changes | ||
labels: | ||
- "*" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: Apply project labels | ||
on: [issues, pull_request_target, label] | ||
jobs: | ||
apply-labels: | ||
name: Apply common project labels | ||
runs-on: ubuntu-latest | ||
permissions: | ||
issues: write | ||
pull-requests: write | ||
steps: | ||
- uses: honeycombio/oss-management/labels@v1 | ||
with: | ||
github-token: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
name: 'Close stale issues and PRs' | ||
on: | ||
schedule: | ||
- cron: '30 1 * * *' | ||
|
||
jobs: | ||
stale: | ||
name: 'Close stale issues and PRs' | ||
runs-on: ubuntu-latest | ||
permissions: | ||
issues: write | ||
pull-requests: write | ||
|
||
steps: | ||
- uses: actions/stale@v4 | ||
with: | ||
start-date: '2021-09-01T00:00:00Z' | ||
stale-issue-message: 'Marking this issue as stale because it has been open 14 days with no activity. Please add a comment if this is still an ongoing issue; otherwise this issue will be automatically closed in 7 days.' | ||
stale-pr-message: 'Marking this PR as stale because it has been open 30 days with no activity. Please add a comment if this PR is still relevant; otherwise this PR will be automatically closed in 7 days.' | ||
close-issue-message: 'Closing this issue due to inactivity. Please see our [Honeycomb OSS Lifecyle and Practices](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md).' | ||
close-pr-message: 'Closing this PR due to inactivity. Please see our [Honeycomb OSS Lifecyle and Practices](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md).' | ||
days-before-issue-stale: 14 | ||
days-before-pr-stale: 30 | ||
days-before-issue-close: 7 | ||
days-before-pr-close: 7 | ||
any-of-labels: 'status: info needed,status: revision needed' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
name: "Validate PR Title" | ||
|
||
on: | ||
pull_request_target: | ||
types: | ||
- opened | ||
- edited | ||
- synchronize | ||
|
||
jobs: | ||
main: | ||
name: Validate PR title | ||
runs-on: ubuntu-latest | ||
permissions: | ||
issues: write | ||
pull-requests: write | ||
steps: | ||
- uses: amannn/action-semantic-pull-request@v5 | ||
id: lint_pr_title | ||
name: "🤖 Check PR title follows conventional commit spec" | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
# Have to specify all types because `maint` and `rel` aren't defaults | ||
types: | | ||
maint | ||
rel | ||
fix | ||
feat | ||
chore | ||
ci | ||
docs | ||
style | ||
refactor | ||
perf | ||
test | ||
ignoreLabels: | | ||
"type: dependencies" | ||
# When the previous steps fails, the workflow would stop. By adding this | ||
# condition you can continue the execution with the populated error message. | ||
- if: always() && (steps.lint_pr_title.outputs.error_message != null) | ||
name: "📝 Add PR comment about using conventional commit spec" | ||
uses: marocchino/sticky-pull-request-comment@v2 | ||
with: | ||
header: pr-title-lint-error | ||
message: | | ||
Thank you for contributing to the project! 🎉 | ||
We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted. | ||
Make sure to prepend with `feat:`, `fix:`, or another option in the list below. | ||
Once you update the title, this workflow will re-run automatically and validate the updated title. | ||
Details: | ||
``` | ||
${{ steps.lint_pr_title.outputs.error_message }} | ||
``` | ||
# Delete a previous comment when the issue has been resolved | ||
- if: ${{ steps.lint_pr_title.outputs.error_message == null }} | ||
name: "❌ Delete PR comment after title has been updated" | ||
uses: marocchino/sticky-pull-request-comment@v2 | ||
with: | ||
header: pr-title-lint-error | ||
delete: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# {project-name} changelog | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Code of Conduct | ||
|
||
This project has adopted the Honeycomb User Community Code of Conduct to clarify expected behavior in our community. | ||
|
||
https://www.honeycomb.io/honeycomb-user-community-code-of-conduct/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Contributing Guide | ||
|
||
Please see our [general guide for OSS lifecycle and practices.](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md) |
Oops, something went wrong.