GitHub 包快速入门

简介

在本指南中，你将创建一个 GitHub Actions 工作流来测试代码，然后将其发布到 GitHub Packages。

发布你的软件包

在 GitHub 上创建一个新仓库，并添加 Node 的 .gitignore。更多信息请参见创建新仓库。

将仓库克隆到本地机器。

git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git
cd YOUR-REPOSITORY

创建一个 index.js 文件，并添加一个基本的 alert，显示“Hello world！”
JavaScript
```
console.log("Hello, World!");
```
```
console.log("Hello, World!");
```
使用 npm init 初始化一个 npm 包。在包初始化向导中，输入你的包名称：@YOUR-USERNAME/YOUR-REPOSITORY，并将测试脚本设为 exit 0。这将生成包含包信息的 package.json 文件。
```
$ npm init
  ...
  package name: @YOUR-USERNAME/YOUR-REPOSITORY
  ...
  test command: exit 0
  ...
```

运行 npm install 生成 package-lock.json 文件，然后提交并推送更改到 GitHub。

npm install
git add index.js package.json package-lock.json
git commit -m "initialize npm package"
git push

创建一个 .github/workflows 目录。在该目录下，创建一个名为 release-package.yml 的文件。

将以下 YAML 内容复制到 release-package.yml 文件中。

YAML

name: Node.js Package

on:
  release:
    types: [created]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm ci
      - run: npm test

  publish-gpr:
    needs: build
    runs-on: ubuntu-latest
    permissions:
      packages: write
      contents: read
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          registry-url: https://npm.pkg.github.com/
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

name: Node.js Package

on:
  release:
    types: [created]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm ci
      - run: npm test

  publish-gpr:
    needs: build
    runs-on: ubuntu-latest
    permissions:
      packages: write
      contents: read
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          registry-url: https://npm.pkg.github.com/
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

使用以下方法之一告诉 npm 将软件包发布到哪个作用域和注册表
- 通过在根目录创建一个包含以下内容的 .npmrc 文件，为仓库添加 npm 配置文件
```
@YOUR-USERNAME:registry=https://npm.pkg.github.com
```
- 编辑 package.json 文件并指定 publishConfig 键
```
"publishConfig": {
  "@YOUR-USERNAME:registry": "https://npm.pkg.github.com"
}
```

提交并推送更改到 GitHub。

$ git add .github/workflows/release-package.yml
# Also add the file you created or edited in the previous step.
$ git add .npmrc or package.json
$ git commit -m "workflow to publish package"
$ git push