GitHub 使用文档

本文包含部分 Vercel 和 Netlify 的内容

转换 CRLF 和 LF

开启自动转换 git config --global core.autocrlf true

指定 commit 时间

需要加上环境变量，如下所示

GIT_COMMITTER_DATE="Jan 1 07:02:01 2024 +0000" git commit --date="Jan 1 07:02:01 2024 +0000" -m "Initial commit"

删除 Contributors 记录

在确保没有该用户的 commit 记录后，随便修改掉默认分支的名称，然后再改回来

利用 Action 发布 releases

on:
  push:
    tags:
      - 'v*.*.*'

permissions:
  contents: write

- name: GH Release
  uses: softprops/action-gh-release@v2
  env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    files: dist/*

利用 Action 发布 ghpage

permissions:
  pages: write
  id-token: write

environment:
  name: github-pages
  url: ${{ steps.deployment.outputs.page_url }}

- name: Upload GitHub Pages artifact
  uses: actions/upload-pages-artifact@v3
  with:
    path: '.'

- name: Deploy GitHub Pages site
  id: deployment
  uses: actions/deploy-pages@v4

下载源代码存档

仓库分支存档的下载链接：github.com/USER/REPO/archive/refs/heads/BRANCH.tar.gz

Release 最新版本的下载链接：github.com/USER/REPO/releases/latest/download/ASSETS.tar.gz

Action Repository 机密

${{ secrets.SECRET_NAME }}

Pull requests 教程

假设被 Pr 的仓库是 atri/momo

点击 atri/momo 仓库右上角的 Fork，然后该仓库会被复制到自己账号（假设自己用户名为 sjw）成为 sjw/momo

在 sjw/momo 里修修改改提交，然后点击 Contribute，再点击底下绿色的 Open a Pull 即可提交 Pr 申请

然后 atri/momo 的 Pull requests 列表中会出现刚刚 sjw 发起的申请，由用户 atri 或其它管理者点击底下绿色的 Merge pull request 即可完成合并

基础使用教程

注册账号，安装配置 git，创建仓库，生成 Token 等步骤略过，不做描述

本文仅讨论使用 GitHub 用户 Token 上传，而非 SSH

以下假设 GitHub 的用户名是 atri，仓库名为 test

1. 在本地拉取储存库

git clone https://github.com/atri/test.git

2. 配置 git 用户信息

进入上述拉取的储存库目录，随后配置用户名，邮箱信息

命令后加上 --global 意味全局配置，不加则仅配置当前储存库的 git 用户信息

git config user.name "atri"
git config user.email "atri<atri@gmail.com>"

3. 更新仓库到 GitHub

自行对储存库的内容进行修改，确认

git add .
git commit -m "对此次修改的注释，可随便填写"

上传到 GitHub，如果出现错误提示，按提示进行对应输入即可，以后的再上传仅需输入 git push

git push origin main

接着输入 GitHub 的用户名，以及 GitHub 用户 Token 即可

Vercel

命令行更新发布项目

需要配置环境变量 VERCEL_ORG_ID，VERCEL_PROJECT_ID，VERCEL_TOKEN

vercel pull --yes --environment=production
vercel build --prod
vercel deploy --prebuilt --prod

命令行删除历史部署记录

vercel remove project-name --safe

Netlify

命令行更新发布项目

需要配置环境变量 NETLIFY_AUTH_TOKEN 和 NETLIFY_SITE_ID

netlify link
netlify build
netlify deploy --dir=dist/ --prod