-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from Dot-Liu/main
APIPark-1.0-beta完成
- Loading branch information
Showing
111 changed files
with
1,255 additions
and
833 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,63 @@ | ||
name: "Bug Report" | ||
description: Report a bug to help improve the project. | ||
title: "bug: " | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for taking the time to report this bug! | ||
_The more information you share, the faster we can identify and fix the bug._ | ||
Prior to opening the issue, please make sure that you: | ||
- Use English to communicate. | ||
- Search the [open issues](https://github.com/APIParkLab/APIPark/issues) and [discussion forum](https://github.com/APIParkLab/APIPark/discussions) to avoid duplicating the issue. | ||
- type: textarea | ||
id: current-behavior | ||
attributes: | ||
label: Current Behavior | ||
description: Describe the issue you are facing. | ||
placeholder: | | ||
What is the issue with the current behavior? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected-behavior | ||
attributes: | ||
label: Expected Behavior | ||
description: Describe what you expected to happen. | ||
placeholder: | | ||
What did you expect to happen instead? | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: error | ||
attributes: | ||
label: Error Logs | ||
description: Paste the error logs if any. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: steps | ||
attributes: | ||
label: Steps to Reproduce | ||
description: Share the steps you took so that we can reproduce the issue. Reports without proper steps details will likely be closed. | ||
placeholder: | | ||
1. Run apinto via the Docker image. | ||
2. Create a Route with the Admin API. | ||
3. Try configuring ... | ||
4. ... | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: environment | ||
attributes: | ||
label: Environment | ||
description: Share your environment details. Reports without proper environment details will likely be closed. | ||
value: | | ||
- APINTO Dashboard version (run `apinto dashboard version`): | ||
- Operating system (run `uname -a`): | ||
validations: | ||
required: true |
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,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: APIPark Discussion Forum | ||
url: https://github.com/APIParkLab/APIPark/discussions | ||
about: Please ask and answer questions here. |
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,33 @@ | ||
name: "Documentation Issue" | ||
description: Issues related to documentation. | ||
title: "docs: " | ||
labels: [doc] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
_The more information you share, the faster we can help you._ | ||
Prior to opening the issue, please make sure that you: | ||
- Use English to communicate. | ||
- Search the [open issues](https://github.com/APIParkLab/APIPark/issues) and [discussion forum](https://github.com/APIParkLab/APIPark/discussions) to avoid duplicating the issue. | ||
- type: textarea | ||
id: current-state | ||
attributes: | ||
label: Current State | ||
description: Describe the current state of the documentation. | ||
placeholder: | | ||
The documentation for the API in this page (url) is missing ... | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: desired-state | ||
attributes: | ||
label: Desired State | ||
description: Describe the desired state the documentation should be in. | ||
placeholder: | | ||
There should be line mentioning how the API behaves when ... | ||
validations: | ||
required: true |
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,23 @@ | ||
name: "Feature Request" | ||
description: Suggest an enhancement to APINTO. | ||
title: "feat: As a user, I want to ..., so that ..." | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
_The more information you share, the faster we can help you._ | ||
Prior to opening the issue, please make sure that you: | ||
- Use English to communicate. | ||
- Search the [open issues](https://github.com/APIParkLab/APIPark/issues) and [discussion forum](https://github.com/APIParkLab/APIPark/discussions) to avoid duplicating the issue. | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: Describe the feature you would like to see. | ||
placeholder: | | ||
As a user, I want to ..., so that... | ||
validations: | ||
required: true |
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,31 @@ | ||
name: "Request Help" | ||
description: Stuck? Ask for help! | ||
title: "help request: " | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
_The more information you share, the faster we can help you._ | ||
Prior to opening the issue, please make sure that you: | ||
- Use English to communicate. | ||
- Search the [open issues](https://github.com/APIParkLab/APIPark/issues) and [discussion forum](https://github.com/APIParkLab/APIPark/discussions) to avoid duplicating the issue. | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: Describe the issue you are facing and what you need help with. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: environment | ||
attributes: | ||
label: Environment | ||
description: Share your environment details. Reports without proper environment details will likely be closed. | ||
value: | | ||
- APIPark version (run `apinto dashboard version`): | ||
- Operating system (run `uname -a`): | ||
validations: | ||
required: true |
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,86 @@ | ||
name: release | ||
#触发机制,当创建tag时 | ||
on: | ||
release: | ||
types: | ||
- published | ||
jobs: | ||
frontend-builder: | ||
name: frontend-builder | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: SetOutput | ||
id: vars | ||
run: echo "tag=${GITHUB_REF#refs/*/v}" >> $GITHUB_OUTPUT | ||
- name: Checkout #Checkout代码 | ||
uses: actions/checkout@v3 | ||
- name: Set up Node | ||
uses: actions/[email protected] | ||
with: | ||
node-version: '18.12' | ||
- name: Pnpm install and build | ||
run: | | ||
npm install -g pnpm | ||
pnpm install --registry https://registry.npmmirror.com --dir ./frontend | ||
echo "Build frontend..." | ||
cd ./frontend && pnpm run build | ||
- name: upload frontend release | ||
uses: actions/upload-artifact@v2 | ||
with: | ||
name: frontend-package | ||
path: frontend/dist | ||
release: | ||
needs: [frontend-builder] | ||
name: release | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: SetOutput #处理Tag字符串并存进outputs | ||
id: vars | ||
run: | | ||
echo "tag=${GITHUB_REF#refs/*/v}" >> $GITHUB_OUTPUT | ||
- name: Checkout #Checkout代码 | ||
uses: actions/checkout@v3 | ||
- name: download frontend release | ||
uses: actions/download-artifact@v2 | ||
with: | ||
name: frontend-package | ||
path: frontend/dist | ||
- name: Set up Go | ||
uses: actions/setup-go@v3 | ||
with: | ||
go-version: '1.21.1' | ||
- name: Go tidy | ||
run: | | ||
go mod tidy | ||
echo "GOVERSION=$(go version)" >> $GITHUB_ENV | ||
- name: Create archives on Release #创建各种系统架构下的二进制包并上传至release assets | ||
uses: goreleaser/[email protected] | ||
with: | ||
version: 1.9.2 | ||
args: release --rm-dist | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
docker-push: | ||
needs: [frontend-builder] | ||
name: docker-push | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: SetOutput | ||
id: vars | ||
run: echo "tag=${GITHUB_REF#refs/*/v}" >> $GITHUB_OUTPUT | ||
- uses: actions/checkout@v3 | ||
|
||
- name: download frontend release | ||
uses: actions/download-artifact@v2 | ||
with: | ||
name: frontend-package | ||
path: frontend/dist | ||
- name: Login Docker #登录docker | ||
uses: docker/login-action@v1 | ||
with: | ||
username: ${{ secrets.DOCKER_USERNAME }} | ||
password: ${{ secrets.DOCKER_TOKEN }} | ||
|
||
- name: build | ||
run: cd scripts && ./docker_publish.sh ${{ secrets.DOCKER_USERNAME }} "backend" | ||
|
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 |
---|---|---|
@@ -1,3 +1,5 @@ | ||
*.DS_Store | ||
/.idea/ | ||
/config.yml | ||
/build/ | ||
/apipark |
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
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
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
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
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
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
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.