-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 4968938
Showing
72 changed files
with
6,099 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
name: Bug 反馈 | ||
description: 提交一个 issue 帮助改进这个项目 | ||
title: "[Bug] 在这里输入你的标题" | ||
labels: ["bug"] | ||
assignees: | ||
- teamssix | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
感谢您花时间提交这份 issue | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: 描述你遇到的问题 | ||
value: "详细描述你所遇到的问题" | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: 复现步骤 | ||
description: 复现这个问题的步骤 | ||
placeholder: | | ||
1. 在 xxx 情况下 | ||
2. 执行了 xxx 命令 | ||
3. 出现了 xxx 错误 | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: system | ||
attributes: | ||
label: 操作系统 | ||
description: 你在哪个操作系统下运行的云鉴 ? | ||
options: | ||
- MacOS | ||
- Linux | ||
- Windows | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: system-type | ||
attributes: | ||
label: 系统类型 | ||
description: 你在哪个系统类型下运行的云鉴 ? | ||
options: | ||
- amd64 | ||
- amd32 | ||
- arm64 | ||
- arm32 | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: cloudsword-version | ||
attributes: | ||
label: 云鉴版本 | ||
description: 你运行的是云鉴的哪个版本? | ||
options: | ||
- 最新的 (Latest) | ||
- 0.0.1 | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: 补充信息 | ||
description: | | ||
链接?参考资料?任何可以给我们提供更多关于你所遇到的问题的背景资料的东西 | ||
提示:你可以通过点击这个区域来突出显示它,然后将文件拖入,从而附上图片或其他文件。 | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: 新功能反馈 | ||
description: 提交一个功能需求帮助完善这个项目 | ||
title: "[Feat] 在这里输入你的标题" | ||
labels: ["enhancement"] | ||
assignees: | ||
- teamssix | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
感谢您花时间提交这份 issue | ||
- type: textarea | ||
id: new-features | ||
attributes: | ||
label: 描述你希望增加的功能 | ||
value: "详细描述你希望增加的功能,并且描述为什么想要增加这个功能以及意义,描述的越完善该反馈越有可能被采纳。" | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: 补充信息 (Anything else?) | ||
description: | | ||
链接?参考资料?任何可以给我们提供更多关于你所遇到的问题的背景资料的东西。 | ||
提示:你可以通过点击这个区域来突出显示它,然后将文件拖入,从而附上图片或其他文件。 | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: 功能优化反馈 | ||
description: 提交一个功能优化需求帮助改进这个项目 | ||
title: "[Perf] 在这里输入你的标题" | ||
labels: ["performance"] | ||
assignees: | ||
- teamssix | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
感谢您花时间提交这份 issue | ||
- type: textarea | ||
id: performance | ||
attributes: | ||
label: 描述你希望优化的功能 | ||
value: "详细描述你希望优化的功能,并且描述为什么想要对这个功能进行优化,描述的越完善该反馈越有可能被采纳。" | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: 补充信息 | ||
description: | | ||
链接?参考资料?任何可以给我们提供更多关于你所遇到的问题的背景资料的东西 | ||
提示:你可以通过点击这个区域来突出显示它,然后将文件拖入,从而附上图片或其他文件。 | ||
validations: | ||
required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Release | ||
on: | ||
push: | ||
tags: | ||
- 'v*' | ||
env: | ||
GO_VERSION: 1.22.1 | ||
|
||
jobs: | ||
goreleaser: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout Source Code | ||
uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 0 | ||
- name: Setup Go Environment | ||
uses: actions/setup-go@v3 | ||
with: | ||
go-version: ${{ env.GO_VERSION }} | ||
|
||
- name: Run GoReleaser | ||
uses: goreleaser/goreleaser-action@v6 | ||
with: | ||
version: 1.26.2 | ||
args: release --clean | ||
env: | ||
CGO_ENABLED: 0 | ||
GITHUB_TOKEN: ${{ secrets.RELEASE_GH_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# If you prefer the allow list template instead of the deny list, see community template: | ||
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore | ||
# | ||
# Binaries for programs and plugins | ||
*.exe | ||
*.exe~ | ||
*.dll | ||
*.so | ||
*.dylib | ||
|
||
# Test binary, built with `go test -c` | ||
*.test | ||
|
||
# Output of the go coverage tool, specifically when used with LiteIDE | ||
*.out | ||
|
||
# Dependency directories (remove the comment below to include it) | ||
# vendor/ | ||
tmp | ||
test | ||
misc | ||
build | ||
|
||
# Go workspace file | ||
go.work | ||
.DS_Store | ||
.idea | ||
cloudsword | ||
cloudsword.bak |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
project_name: cloudsword | ||
before: | ||
hooks: | ||
- go mod tidy | ||
- go generate ./... | ||
builds: | ||
- env: | ||
- CGO_ENABLED=0 | ||
goos: | ||
- freebsd | ||
- darwin | ||
- windows | ||
- linux | ||
goarch: | ||
- 386 | ||
- amd64 | ||
- arm | ||
- arm64 | ||
archives: | ||
- name_template: "{{ .ProjectName }}_{{ .Tag }}_{{ .Os }}_{{ .Arch }}" | ||
id: homebrew | ||
format: zip | ||
files: | ||
- README.md | ||
- CHANGELOG.md | ||
- LICENSE | ||
- static/* | ||
checksum: | ||
name_template: "checksums.txt" | ||
snapshot: | ||
name_template: "{{ incpatch .Version }}" | ||
changelog: | ||
sort: asc | ||
filters: | ||
exclude: | ||
- "^docs:" | ||
- "^doc:" | ||
- "^ci:" | ||
- "^Merge pull request" | ||
brews: | ||
- ids: | ||
- homebrew | ||
name: cloudsword | ||
tap: | ||
owner: wgpsec | ||
name: homebrew-tap | ||
branch: master | ||
folder: Formula | ||
url_template: "https://github.com/wgpsec/cloudsword/releases/download/{{ .Tag }}/{{ .ArtifactName }}" | ||
homepage: "https://wiki.teamssix.com/cloudsword" | ||
description: "CloudSword is a public cloud security exploitation tool." | ||
skip_upload: auto | ||
install: |- | ||
bin.install "cloudsword" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## [v0.0.1](https://github.com/wgpsec/cloudsword/releases/tag/v0.0.1) 2024.12.21 | ||
|
||
* 首次提交代码 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
## 为云鉴贡献代码 | ||
|
||
首先很高兴你看到这个,非常欢迎您和我一起完善云鉴,让我们一起编写一个好用的、有价值的、有意义的工具。 | ||
|
||
### 是否发现了 bug? | ||
|
||
如果你发现了程序中的 bug,建议可以先在 [issue](https://github.com/wgpsec/cloudsword/issues) 中进行搜索,看看以前有没有人提交过相同的 bug。 | ||
|
||
### 发现了 bug,并准备自己为云鉴打补丁 | ||
|
||
如果你发现了 bug,而且准备自己去修补它的话,则可以先把云鉴 Fork 到自己的仓库中,然后修复完后,提交 PR 到云鉴的 dev 分支下,另外记得在 PR 中详细说明 bug 的产生条件以及你是如何修复的,这可以帮助你更快地使这个 PR 通过。 | ||
|
||
### 为云鉴增加新功能 | ||
|
||
如果你发现云鉴现在的功能不能满足自己的需求,并打算自己去增加上这个功能,则可以先把云鉴 Fork 到自己的仓库中,然后编写完相应的功能后,提交 PR 到云鉴 的 dev 分支下,另外记得在 PR 中详细说明增加的功能以及为什么要增加它,这可以帮助你更快地使这个 PR 通过。 | ||
|
||
建议师傅在增加新功能后,可以去完善对应的操作手册,操作手册项目地址:[github.com/teamssix/twiki](https://github.com/teamssix/twiki),先 fork 操作手册项目,然后在 [github. | ||
com/teamssix/twiki/tree/main/docs/cloudsword](https://github.com/teamssix/twiki/tree/main/docs/cloudsword) 目录下编辑云鉴 操作手册的文档,最后提 pr 到 T Wiki 项目的 beta 分支下就行。 | ||
|
||
## 使你的 PR 更规范 | ||
|
||
### 规范 Git commit | ||
|
||
commit message 应尽可能的规范,为了保证和其他 commit 统一,建议 commit message 采用英文描述,并符合下面的格式: | ||
|
||
```yaml | ||
type: subject | ||
``` | ||
type 是 commit 的类别,subject 是对这个 commit 的英文描述,例如下面的示例: | ||
* feat: add object download function | ||
* perf: optimize the display of update progress bar | ||
关于 Git commit 的更多规范要求可以参见这篇文章:[如何规范你的Git commit?](https://zhuanlan.zhihu.com/p/182553920) | ||
### 规范代码格式 | ||
代码在编写完后,应使用 `go fmt` 和 `goimports`对代码进行格式化,从而使代码看起来更加整洁。 | ||
|
||
在 goland 中可以设置当代码保存时自动格式化代码,配置的步骤可以参见这篇文章:[GoLand:设置gofmt与goimports,保存时自动格式化代码](https://blog.csdn.net/qq_32907195/article/details/116755338) |
Oops, something went wrong.