diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 00000000..27eca10a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,11 @@ +--- +name: Enhancement Request +about: Suggest an enhancement to the project +labels: kind/feature + +--- + + +**What would you like to be added**: + +**Why is this needed**: diff --git a/.github/ISSUE_TEMPLATE/request-doc.md b/.github/ISSUE_TEMPLATE/request-doc.md new file mode 100644 index 00000000..a463ff1e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/request-doc.md @@ -0,0 +1,17 @@ +--- +name: Request Documentation +about: Request for new documents or supplementation or updating of existing documents. +labels: help wanted +--- + +**What documentation would you like to be added**: + +**Why do you think this document is needed**: + +**Where do you think the document should be placed**: + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..2a33a753 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ +**What type of PR is this?** + + + +**What this PR does / why we need it**: + +**Which issue(s) this PR fixes**: +Fixes # + +**Special notes for your reviewer**: + + diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..db9ba417 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: 'npm' + directory: '/' + schedule: + interval: 'weekly' diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 00000000..e422d740 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,51 @@ +name: 部署到 GitHub Pages + +on: + push: + branches: + - main + # 如果你想要进一步定义触发、路径以及其他内容,请检阅 Github Actions 文档 + # https://docs.github.com/zh/actions/using-workflows/workflow-syntax-for-github-actions#on + +jobs: + build: + name: 构建 Docusaurus + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 18 + cache: yarn + + - name: 安装依赖 + run: yarn install --frozen-lockfile + - name: 构建网站 + run: yarn build + + - name: 上传构建制品 + uses: actions/upload-pages-artifact@v3 + with: + path: build + + deploy: + name: 部署到 GitHub Pages + needs: build + + # 给予 GITHUB_TOKEN 进行 Pages 部署所必须的权限 + permissions: + pages: write # 以部署到 Pages + id-token: write # 以验证部署来自恰当的源 + + # 部署到 Github Pages 环境 + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + steps: + - name: 部署到 GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml new file mode 100644 index 00000000..46a6350e --- /dev/null +++ b/.github/workflows/test-deploy.yml @@ -0,0 +1,26 @@ +name: 测试部署 + +on: + pull_request: + branches: + - main + # 如果你想要进一步定义触发、路径以及其他内容,请检阅 Github Actions 文档 + # https://docs.github.com/zh/actions/using-workflows/workflow-syntax-for-github-actions#on + +jobs: + test-deploy: + name: 测试部署 + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 18 + cache: yarn + + - name: 安装依赖 + run: yarn install --frozen-lockfile + - name: 测试构建网站 + run: yarn build diff --git a/.github/workflows/typos.yml b/.github/workflows/typos.yml new file mode 100644 index 00000000..f543f5c6 --- /dev/null +++ b/.github/workflows/typos.yml @@ -0,0 +1,15 @@ +name: Typos Check +on: + push: + pull_request: +jobs: + typos-check: + name: Spell Check with Typos + runs-on: ubuntu-22.04 + steps: + - name: Checkout Actions Repository + uses: actions/checkout@v4 + - name: Check spelling with custom config file + uses: crate-ci/typos@v1.17.2 + with: + config: ./typos.toml