Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(new): add the checklist #674

Merged
merged 4 commits into from
Apr 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 6 additions & 21 deletions pkg/create-pr-new-pkg/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package newpkg

import (
"context"
_ "embed"
"errors"
"fmt"
"io"
Expand All @@ -14,7 +15,10 @@ import (
"gopkg.in/yaml.v3"
)

func CreatePRNewPkgs(ctx context.Context, pkgNames ...string) error { //nolint:cyclop,funlen
//go:embed pr_template.md
var bodyTemplate []byte

func CreatePRNewPkgs(ctx context.Context, pkgNames ...string) error { //nolint:cyclop
if len(pkgNames) == 0 {
return errors.New(`usage: $ aqua-registry create-pr-new-pkg <pkgname>...
e.g. $ aqua-registry create-pr-new-pkg cli/cli`)
Expand Down Expand Up @@ -46,26 +50,7 @@ e.g. $ aqua-registry create-pr-new-pkg cli/cli`)
"$ aqua g -i " + strings.Join(pkgNames, " "),
"```",
"",
"## How to confirm if this package works well",
"",
"Reviewers aren't necessarily familiar with this package, so please describe how to confirm if this package works well.",
"Please confirm if this package works well yourself as much as possible.",
"",
"Command and output",
"",
"```console",
"$ ",
"```",
"",
"If files such as configuration file are needed, please share them.",
"",
"```",
"```",
"",
"Reference",
"",
"-",
"",
string(bodyTemplate),
}...), "\n")
pkgName := pkgNames[0]
branch := "feat/" + pkgName
Expand Down
28 changes: 28 additions & 0 deletions pkg/create-pr-new-pkg/pr_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Check List

<!-- Please check the list. Please don't remove the check list. -->

- [ ] Read [CONTRIBUTING.md](https://aquaproj.github.io/docs/products/aqua-registry/contributing)
- [ ] Read [OSS Contribution Guide](https:/suzuki-shunsuke/oss-contribution-guide/blob/main/README.md)
- [ ] [All commits are signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
- [ ] [Avoid force push](https:/suzuki-shunsuke/oss-contribution-guide?tab=readme-ov-file#dont-do-force-pushes-after-opening-pull-requests)
- [ ] Do only one thing in one Pull Request
- [ ] [Execute cmdx s to scaffold code](https://aquaproj.github.io/docs/products/aqua-registry/contributing/#use-cmdx-s-definitely)
- [ ] Install and execute the package and confirm if the package works well

## How to confirm if this package works well

Reviewers aren't necessarily familiar with this package, so please describe how to confirm if this package works well.
Please confirm if this package works well yourself as much as possible.

Command and output

```console
$
```

If files such as configuration file are needed, please share them.

Reference

-