From 0c374a5d4641bf2f60d406cd84f171e7214deb1e Mon Sep 17 00:00:00 2001 From: Bee Klimt Date: Wed, 31 Jul 2024 13:12:46 -0700 Subject: [PATCH] Initial commit --- .github/CODEOWNERS | 6 + .github/ISSUE_TEMPLATE/bug_report.md | 25 +++ .github/ISSUE_TEMPLATE/feature_request.md | 25 +++ .github/ISSUE_TEMPLATE/question-discussion.md | 14 ++ .../security-vulnerability-report.md | 19 ++ .github/PULL_REQUEST_TEMPLATE.md | 12 ++ .github/release.yml | 25 +++ .github/workflows/apply-labels.yml | 13 ++ .github/workflows/stale.yml | 26 +++ .github/workflows/validate-pr-title.yml | 67 ++++++ CHANGELOG.md | 2 + CODE_OF_CONDUCT.md | 5 + CONTRIBUTING.md | 3 + LICENSE | 201 ++++++++++++++++++ NOTICE | 13 ++ OSSMETADATA | 1 + README.md | 10 + RELEASING.md | 11 + SECURITY.md | 26 +++ SUPPORT.md | 3 + 20 files changed, 507 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question-discussion.md create mode 100644 .github/ISSUE_TEMPLATE/security-vulnerability-report.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/release.yml create mode 100644 .github/workflows/apply-labels.yml create mode 100644 .github/workflows/stale.yml create mode 100644 .github/workflows/validate-pr-title.yml create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 NOTICE create mode 100755 OSSMETADATA create mode 100644 README.md create mode 100644 RELEASING.md create mode 100644 SECURITY.md create mode 100644 SUPPORT.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..682c4a5 --- /dev/null +++ b/.github/CODEOWNERS @@ -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 + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..26d73c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,25 @@ +--- +name: Bug report +about: Let us know if something is not working as expected +title: '' +labels: 'type: bug' +assignees: '' + +--- + + + +**Versions** + + +**Steps to reproduce** + +1. + +**Additional context** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..457405f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,25 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'type: enhancement' +assignees: '' + +--- + + + +**Is your feature request related to a problem? Please describe.** + + +**Describe the solution you'd like** + + +**Describe alternatives you've considered** + + +**Additional context** diff --git a/.github/ISSUE_TEMPLATE/question-discussion.md b/.github/ISSUE_TEMPLATE/question-discussion.md new file mode 100644 index 0000000..63cc4a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question-discussion.md @@ -0,0 +1,14 @@ +--- +name: Question/Discussion +about: General question about how things work or a discussion +title: '' +labels: 'type: discussion' +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/security-vulnerability-report.md b/.github/ISSUE_TEMPLATE/security-vulnerability-report.md new file mode 100644 index 0000000..38d9002 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security-vulnerability-report.md @@ -0,0 +1,19 @@ +--- +name: Security vulnerability report +about: Let us know if you discover a security vulnerability +title: '' +labels: 'type: security' +assignees: '' + +--- + + +**Versions** + +**Description** + +(Please include any relevant CVE advisory links) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f3c1e03 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ + + +## Which problem is this PR solving? + +- Closes # + +## Short description of the changes + +## How to verify that this has the expected result diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000..041c00a --- /dev/null +++ b/.github/release.yml @@ -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: + - "*" diff --git a/.github/workflows/apply-labels.yml b/.github/workflows/apply-labels.yml new file mode 100644 index 0000000..f757922 --- /dev/null +++ b/.github/workflows/apply-labels.yml @@ -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 }} diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml new file mode 100644 index 0000000..d4a449e --- /dev/null +++ b/.github/workflows/stale.yml @@ -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' diff --git a/.github/workflows/validate-pr-title.yml b/.github/workflows/validate-pr-title.yml new file mode 100644 index 0000000..a9cfdcb --- /dev/null +++ b/.github/workflows/validate-pr-title.yml @@ -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 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0bf4a14 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,2 @@ +# {project-name} changelog + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..bf46524 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0cc0b86 --- /dev/null +++ b/CONTRIBUTING.md @@ -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) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..9b25a98 --- /dev/null +++ b/NOTICE @@ -0,0 +1,13 @@ +Copyright (c) 2016-Present Honeycomb, Hound Technology, Inc. All Rights Reserved. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/OSSMETADATA b/OSSMETADATA new file mode 100755 index 0000000..b96d4a4 --- /dev/null +++ b/OSSMETADATA @@ -0,0 +1 @@ +osslifecycle=active diff --git a/README.md b/README.md new file mode 100644 index 0000000..0c7d003 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# Default Community Health Files + +This repository contains default community health files for repositories in the Honeycomb organization and will automatically be picked up if they are not overwritten. + +More details on this repository structure can be found here: https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file + +# {project-name} + + + diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..f73441e --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,11 @@ +# Releasing + +- `Add steps to prepare release` +- Update `CHANGELOG.md` with the changes since the last release. +- Commit changes, push, and open a release preparation pull request for review. +- Once the pull request is merged, fetch the updated `main` branch. +- Apply a tag for the new version on the merged commit (e.g. `git tag -a v1.2.3 -m "v1.2.3"`) +- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v1.2.3` +- Copy change log entry for newest version into draft GitHub release created as part of CI publish steps. + - Make sure to "generate release notes" in github for full changelog notes and any new contributors +- Publish the github draft release and this will kick off publishing to GitHub and the NPM registry. \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..71d0fbb --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,26 @@ +# Security Policy + +This security policy applies to public projects under the [honeycombio organization][gh-organization] on GitHub. +For security reports involving the services provided at `(ui|ui-eu|api|api-eu).honeycomb.io`, refer to the [Honeycomb Bug Bounty Program][bugbounty] for scope, expectations, and reporting procedures. + +## Security/Bugfix Versions + +Security and bug fixes are generally provided only for the last minor version. +Fixes are released either as part of the next minor version or as an on-demand patch version. + +Security fixes are given priority and might be enough to cause a new version to be released. + +## Reporting a Vulnerability + +We encourage responsible disclosure of security vulnerabilities. +If you find something suspicious, we encourage and appreciate your report! + +### Ways to report + +In order for the vulnerability reports to reach maintainers as soon as possible, the preferred way is to use the "Report a vulnerability" button under the "Security" tab of the associated GitHub project. +This creates a private communication channel between the reporter and the maintainers. + +If you are absolutely unable to or have strong reasons not to use GitHub's vulnerability reporting workflow, please reach out to the Honeycomb security team at [security@honeycomb.io](mailto:security@honeycomb.io). + +[gh-organization]: https://github.com/honeycombio +[bugbounty]: https://www.honeycomb.io/bugbountyprogram diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..9164e06 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,3 @@ +# How to Get Help + +This project uses GitHub issues to track bugs, feature requests, and questions about using the project. Please search for existing issues before filing a new one.