diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..2b4e26b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Tailpipe version (`tailpipe -v`)** +Example: v0.1.0 + +**To reproduce** +Steps to reproduce the behavior (please include relevant code and/or commands). + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..11fc491 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/release_issue.md b/.github/ISSUE_TEMPLATE/release_issue.md new file mode 100644 index 0000000..fb5d966 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release_issue.md @@ -0,0 +1,32 @@ +--- +name: Tailpipe Release +about: Tailpipe Release +title: "Tailpipe v<INSERT_VERSION_HERE>" +labels: release +--- + +#### Changelog + +[Tailpipe v<INSERT_VERSION_HERE> Changelog](https://github.com/turbot/tailpipe/blob/v<INSERT_VERSION_HERE>/CHANGELOG.md) + +## Checklist + +### Pre-release checks + +- [ ] All PR acceptance test pass in `tailpipe` +- [ ] Update check is working +- [ ] Tailpipe Changelog updated and reviewed + +### Release Tailpipe + +- [ ] Merge the release PR +- [ ] Trigger the `01 - Tailpipe: Release` workflow. This will create the release build. + +### Post-release checks + +- [ ] Update Changelog in the Release page (copy and paste from CHANGELOG.md) +- [ ] Test Linux install script +- [ ] Test Homebrew install +- [ ] Release branch merged to `develop` +- [ ] Raise Changelog update to `tailpipe.io`, get it reviewed. +- [ ] Merge Changelog update to `tailpipe.io`. \ No newline at end of file diff --git a/README.md b/README.md index 2bed553..8c738f5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[<picture><source media="(prefers-color-scheme: dark)" srcset="https://tailpipe-io.vercel.app/images/tailpipe_wordmark.svg"><source media="(prefers-color-scheme: light)" srcset="https://tailpipe-io.vercel.app/images/tailpipe_wordmark.svg"><img width="67%" alt="Tailpipe Logo" src="https://tailpipe-io.vercel.app/images/tailpipe_wordmark.svg"></picture>](https://tailpipe-io.vercel.app) +<a href="https://tailpipe.io"><img width="67%" src="https://tailpipe.io/images/pipeling-wordmarks/tailpipe_wordmark.svg" /></a> [](https://hub.tailpipe-io.vercel.app/) [](https://hub.tailpipe-io.vercel.app/) @@ -17,18 +17,24 @@ **Built to build with**. Define detections as code, extend functionality with plugins and write custom SQL queries. +## Demo time! + +**[Watch on YouTube →](https://www.youtube.com/watch?v=IR9MK1DMvW4)** + +<a href="https://www.youtube.com/watch?v=IR9MK1DMvW4"><img alt="tailpipe demo" width=500 src="https://tailpipe.io/images/video_preview.png"></a> + ## Documentation -See the [documentation](https://tailpipe-io.vercel.app/docs) for: +See the [documentation](https://tailpipe.io/docs) for: -- [Getting started](https://tailpipe-io.vercel.app/docs) -- [It's just SQL!](https://tailpipe-io.vercel.app/docs/sql) -- [Managing Tailpipe](https://tailpipe-io.vercel.app/docs/manage) -- [CLI commands](https://tailpipe-io.vercel.app/docs/reference/cli) +- [Getting started](https://tailpipe.io/docs) +- [It's just SQL!](https://tailpipe.io/docs/sql) +- [Managing Tailpipe](https://tailpipe.io/docs/manage) +- [CLI commands](https://tailpipe.io/docs/reference/cli) ## Install Tailpipe -Install Tailpipe from the [downloads](https://tailpipe-io.vercel.app/downloads) page: +Install Tailpipe from the [downloads](https://tailpipe.io/downloads) page: ```sh # MacOS @@ -37,12 +43,12 @@ brew install turbot/tap/tailpipe ``` # Linux or Windows (WSL2) -sudo /bin/sh -c "$(curl -fsSL https://tailpipe-io.vercel.app/install/tailpipe.sh)" +sudo /bin/sh -c "$(curl -fsSL https://tailpipe.io/install/tailpipe.sh)" ``` ## Install a plugin -Install a plugin for your favorite service (e.g. [AWS](https://hub.tailpipe-io.vercel.app/plugins/turbot/aws), [Azure](https://hub.tailpipe-io.vercel.app/plugins/turbot/azure), [GCP](https://hub.tailpipe-io.vercel.app/plugins/turbot/gcp), [Pipes](https://hub.tailpipe-io.vercel.app/plugins/turbot/pipes). +Install a plugin for your favorite service (e.g. [AWS](https://hub.tailpipe.io/plugins/turbot/aws), [Azure](https://tailpipe.io/plugins/turbot/azure), [GCP](https://tailpipe.io/plugins/turbot/gcp), [Pipes](https://tailpipe.io/plugins/turbot/pipes). ```sh tailpipe plugin install aws @@ -146,7 +152,7 @@ Tailpipe version 0.1.0 This repository is published under the [AGPL 3.0](https://www.gnu.org/licenses/agpl-3.0.html) license. Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). Contributors must sign our [Contributor License Agreement](https://turbot.com/open-source#cla) as part of their first pull request. We look forward to collaborating with you! -[Tailpipe](https://tailpipe-io.vercel.app) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source). +[Tailpipe](https://tailpipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source). ## Get involved