From 688bb066b943c6be4fd3afaf3e0b0209f39f8db5 Mon Sep 17 00:00:00 2001 From: Shunsuke Suzuki Date: Mon, 9 Dec 2024 08:45:44 +0900 Subject: [PATCH] chore: add an issue template to add a new package (#29692) --- .github/ISSUE_TEMPLATE/new-package.yml | 72 ++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/new-package.yml diff --git a/.github/ISSUE_TEMPLATE/new-package.yml b/.github/ISSUE_TEMPLATE/new-package.yml new file mode 100644 index 00000000000..dafb9f4196b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-package.yml @@ -0,0 +1,72 @@ +name: Add a New Package +description: Request to add a new package to the registry +labels: + - enhancement +body: + - type: markdown + attributes: + value: | + # :warning: Note + - [aqua doesn't support building packages from source except for `go install`, `go build`, and `cargo install`.](https://aquaproj.github.io/docs/reference/restriction/#aqua-doesnt-support-running-any-external-commands-to-install-tools) + - aqua doesn't install dependencies. + - aqua doesn't support running scripts while installing tools. + - aqua doesn't support setting environment variables and shell completions while installing tools. + - type: textarea + id: source-url + attributes: + label: Source URL + description: GitHub Repository, GitLab Repository, etc. If this tool is not open source, please fill in `Not Open Source`. + validations: + required: true + - type: textarea + id: homepage-url + attributes: + label: Homepage URL + description: The website of the tool + validations: + required: false + - type: textarea + id: command-names + attributes: + label: Command names + validations: + required: true + - type: textarea + id: how-to-confirm + attributes: + label: How to confirm after installation + value: | + > e.g. `gh version` + + ```sh + + ``` + validations: + required: true + - type: textarea + id: how-to-install + attributes: + label: How to install + value: | + [aqua supports several install ways](https://aquaproj.github.io/docs/reference/registry-config/#package-types). + + > e.g. https://suzuki-shunsuke.github.io/tfcmt/install + + The tool's official installation guide: + + - [ ] Download pre-built binaries + - [ ] GitHub Releases + - [ ] Files in the GitHub repository + - [ ] URL: + - [ ] Build from source + - [ ] go install: `go install ` + - [ ] go build: `go build ` + - [ ] cargo install `cargo install ` + validations: + required: true + - type: textarea + id: note + attributes: + label: Note + validations: + required: false