Skip to content

Commit

Permalink
chore: add an issue template to add a new package (#29692)
Browse files Browse the repository at this point in the history
  • Loading branch information
suzuki-shunsuke authored Dec 8, 2024
1 parent 9de1e24 commit 688bb06
Showing 1 changed file with 72 additions and 0 deletions.
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/new-package.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 688bb06

Please sign in to comment.