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

📝 docs: move readme contents to static document #86

Merged
merged 46 commits into from
Feb 4, 2025
Merged

📝 docs: move readme contents to static document #86

merged 46 commits into from
Feb 4, 2025

Conversation

SigureMo
Copy link
Member

@SigureMo SigureMo commented Jul 9, 2022

动机

添加一个「全新」的静态文档~(3 年前可以说全新,现在不新了都)

emmmmm,还是懒得写,还是先放着吧……

preview: https://yutto.nyakku.moe/

类型

  • ✨ feat: 添加新功能
  • 🐛 fix: 修复 bug
  • 📝 docs: 对文档进行修改
  • ♻️ refactor: 代码重构(既不是新增功能,也不是修改 bug 的代码变动)
  • ⚡ perf: 提高性能的代码修改
  • 🧑‍💻 dx: 优化开发体验
  • 🔨 workflow: 工作流变动
  • 🏷️ types: 类型声明修改
  • 🚧 wip: 工作正在进行中
  • ✅ test: 测试用例添加及修改
  • 🔨 build: 影响构建系统或外部依赖关系的更改
  • 👷 ci: 更改 CI 配置文件和脚本
  • ❓ chore: 其它不涉及源码以及测试的修改
  • ⬆️ deps: 依赖项修改
  • 🔖 release: 发布新版本

Comment on lines 12 to 53
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
submodules: true

- name: Install pnpm
uses: pnpm/action-setup@v2
with:
package_json_file: "docs/package.json"
version: "latest"

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: "20"
cache: "pnpm"
cache-dependency-path: "docs/pnpm-lock.yaml"

- name: Install dependencies
working-directory: ./docs
run: pnpm i --frozen-lockfile

- name: Build VitePress site
working-directory: ./docs
run: pnpm build

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
# if: github.ref == 'refs/heads/main' # Uncomment this before merge this PR
with:
personal_token: ${{ secrets.PERSONAL_TOKEN }}
publish_dir: docs/.vitepress/dist
external_repository: SigureMo/docs
publish_branch: yutto
force_orphan: true
commit_message: ":rocket: deploy: "
user_name: "github-actions[bot]"
user_email: "github-actions[bot]@users.noreply.github.com"

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions Job or Workflow does not set permissions
.github/workflows/vitepress-deploy.yml Dismissed Show dismissed Hide dismissed
.github/workflows/vitepress-deploy.yml Fixed Show fixed Hide fixed
Copy link

codspeed-hq bot commented Feb 1, 2025

CodSpeed Performance Report

Merging #86 will not alter performance

Comparing docs (2c6f5cc) with main (8a9f2ec)

Summary

✅ 30 untouched benchmarks

Comment on lines +79 to +104
name: Lint and Format (Docs)
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v2
with:
package_json_file: "docs/package.json"
version: "latest"

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: "22"
cache: "pnpm"
cache-dependency-path: "docs/pnpm-lock.yaml"

- name: Install dependencies
working-directory: ./docs
run: pnpm i --frozen-lockfile

- name: Format check
working-directory: ./docs
run: pnpm fmt:check

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions Job or Workflow does not set permissions
.github/workflows/lint-and-fmt.yml Dismissed Show dismissed Hide dismissed
@SigureMo SigureMo changed the title 📝 docs: initial docs 📝 docs: move readme contents to static document Feb 4, 2025
@SigureMo SigureMo marked this pull request as ready for review February 4, 2025 16:24
run: pnpm build

- name: Deploy
uses: peaceiris/actions-gh-pages@v3

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action 'VitePress Deploy' step
Uses Step
uses 'peaceiris/actions-gh-pages' with ref 'v3', not a pinned commit hash
@SigureMo SigureMo merged commit c84d44f into main Feb 4, 2025
37 checks passed
@SigureMo SigureMo deleted the docs branch February 4, 2025 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant