-
Notifications
You must be signed in to change notification settings - Fork 52
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: add docs stie for api-testing #469
Merged
LinuxSuRen
merged 4 commits into
LinuxSuRen:master
from
yuluo-yx:0601-yuluo/add-docs-site
Jun 12, 2024
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,54 @@ | ||
{ | ||
"MD001": true, | ||
"MD002": false, | ||
"MD003": false, | ||
"MD004": false, | ||
"MD005": false, | ||
"MD006": false, | ||
"MD007": false, | ||
"MD008": false, | ||
"MD009": false, | ||
"MD010": false, | ||
"MD011": false, | ||
"MD012": false, | ||
"MD013": false, | ||
"MD014": false, | ||
"MD015": false, | ||
"MD016": false, | ||
"MD017": false, | ||
"MD018": false, | ||
"MD019": false, | ||
"MD020": false, | ||
"MD021": false, | ||
"MD022": false, | ||
"MD023": false, | ||
"MD024": false, | ||
"MD025": false, | ||
"MD026": false, | ||
"MD027": false, | ||
"MD028": false, | ||
"MD029": false, | ||
"MD030": false, | ||
"MD031": true, | ||
"MD032": false, | ||
"MD033": false, | ||
"MD034": false, | ||
"MD035": false, | ||
"MD036": false, | ||
"MD037": true, | ||
"MD038": true, | ||
"MD039": false, | ||
"MD040": false, | ||
"MD041": false, | ||
"MD042": false, | ||
"MD043": false, | ||
"MD044": false, | ||
"MD045": false, | ||
"MD046": false, | ||
"MD047": false, | ||
"MD048": false, | ||
"MD049": false, | ||
"MD050": false, | ||
"MD051": 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,99 @@ | ||
name: Hugo Docs | ||
on: | ||
push: | ||
branches: | ||
- "master" | ||
paths: | ||
- 'docs/site/**' | ||
- 'tools/make/docs.mk' | ||
pull_request: | ||
branches: | ||
- "main" | ||
paths: | ||
- 'docs/site/**' | ||
- 'tools/make/docs.mk' | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
docs-lint: | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- name: Check out code | ||
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 | ||
with: | ||
ref: ${{ github.event.pull_request.head.sha }} | ||
|
||
- uses: ./tools/github-actions/setup-deps | ||
|
||
- name: Run markdown linter | ||
uses: nosborn/github-action-markdown-cli@9b5e871c11cc0649c5ac2526af22e23525fa344d # v3.3.0 | ||
with: | ||
files: docs/site/content/* | ||
config_file: ".github/markdown_lint_config.json" | ||
|
||
- name: Install linkinator | ||
run: npm install -g linkinator@6.0.4 | ||
|
||
- name: Check links | ||
run: make docs docs-check-links | ||
|
||
docs-build: | ||
runs-on: ubuntu-latest | ||
needs: docs-lint | ||
permissions: | ||
contents: write | ||
steps: | ||
- name: Git checkout | ||
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 | ||
with: | ||
submodules: true | ||
ref: ${{ github.event.pull_request.head.sha }} | ||
|
||
- uses: ./tools/github-actions/setup-deps | ||
|
||
- name: Setup Hugo | ||
uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0 | ||
with: | ||
hugo-version: 'latest' | ||
extended: true | ||
|
||
- name: Setup Node | ||
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.1.0 | ||
with: | ||
node-version: '18' | ||
|
||
- name: Install Site Dependencies and Build Site | ||
run: make docs docs-check-links | ||
|
||
# Upload docs for GitHub Pages | ||
- name: Upload GitHub Pages artifact | ||
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1 | ||
with: | ||
# Path of the directory containing the static assets. | ||
path: docs/site/public | ||
# Duration after which artifact will expire in days. | ||
# retention-days: # optional, default is 1 | ||
|
||
# This workflow contains a single job called "build" | ||
docs-publish: | ||
if: github.event_name == 'push' | ||
runs-on: ubuntu-latest | ||
needs: docs-build | ||
|
||
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment | ||
permissions: | ||
pages: write # to deploy to Pages | ||
deployments: write | ||
id-token: write # to verify the deployment originates from an appropriate source | ||
|
||
# Deploy to the github-pages environment | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
|
||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 |
This file was deleted.
Oops, something went wrong.
File renamed without changes.
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 @@ | ||
/public | ||
resources/ | ||
node_modules/ | ||
package-lock.json | ||
.hugo_build.lock |
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 @@ | ||
lts/* |
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,4 @@ | ||
FROM klakegg/hugo:ext-alpine@sha256:536dd4805d0493ee13bf1f3df3852ed1f26d1625983507c8c56242fc029b44c7 | ||
|
||
RUN apk add git && \ | ||
git config --global --add safe.directory /src |
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.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@LinuxSuRen pls review it