Publicar pacotes do Node.js

Introdução

Este guia mostra como criar um fluxo de trabalho que publica pacotes do Node.js em GitHub Package Registry e nos registros npm após os testes de integração contínua (CI) serem aprovados.

Pré-requisitos

Recomendamos que você tenha um entendimento básico das opções de configuração do fluxo de trabalho e de como criar um arquivo do fluxo de trabalho. Para obter mais informações, consulte "Aprenda GitHub Actions".

Para obter mais informações sobre a criação de um fluxo de trabalho de CI para seu projeto Node.js, consulte "Usando Node.js com GitHub Actions".

Você também pode achar útil ter um entendimento básico do seguinte:

• "Trabalhando com o registro npm"
• "Variáveis de ambiente"
• "Segredos criptografados"
• "Autenticação em um fluxo de trabalho"

Sobre a configuração do pacote

Os campos nome e versão no arquivo package.json cria um identificador único que os registros usam para vincular seu pacote a um registro. Você pode adicionar um resumo para página de listagem do pacote ao incluir um campo descrição no arquivo package.json. Para obter mais informações, consulte "Criando um pacote package.json" e "Criando módulos Node.js" na documentação do npm.

Quando um arquivo .npmrc local existe e tem um valor de registro especificado, o comando publicação do npm usa o registro configurado no arquivo .npmrc. Você pode usar a ação setup-node para criar um arquivo local .npmrc no executor que configura o escopo e registro padrão. A ação setup-node também aceita um token de autenticação como entrada, usada para acessar registros privados ou publicar pacotes de nós. Para obter mais informações, consulte setup-node.

Você pode especificar a versão do Node.js instalada no executor usando a ação setup-node.

Se você adicionar etapas ao seu fluxo de trabalho para configurar os campos publishConfig no seu arquivo package.json, você não precisará especificar o registry-url usando a ação de setup-node. No entanto, você estará limitado �  publicação do pacote em um registro. Para obter mais informações, consulte "publishConfig" na documentação npm.

Publicar pacotes no registro npm

Cada vez que você criar uma nova versão, você poderá acionar um fluxo de trabalho para publicar o seu pacote. O fluxo de trabalho no exemplo abaixo é executado quando o evento versão é acionado com o tipo criado. O fluxo de trabalho publica o pacote no registro npm se o teste de CI for aprovado.

Para executar operações autenticadas para o registro npm em seu fluxo de trabalho, você precisará armazenar seu token de autenticação npm como um segredo. Por exemplo, crie um repositório secreto denominado NPM_TOKEN. Para obter mais informações, consulte "Criando e usando segredos encriptados".

Por padrão, o npm usa o campo nome do arquivo package.json para determinar o nome do seu pacote publicado. Ao publicar em um namespace global, você precisa incluir apenas o nome do pacote. Por exemplo, você publicaria um pacote denominado npm-hello-world-test em https://www.npmjs.com/package/npm-hello-world-test.

Se você estiver publicando um pacote que inclui um prefixo de escopo, inclua o escopo no nome do arquivo package.json. Por exemplo, se o prefixo de escopo do npm é octocat e o nome do pacote é hello-world, o nome no seu arquivo package.json deverá ser @octocat/hello-world. Se seu pacote npm usar um prefixo de escopo e for público, você deverá usar a opção npm publish --access public. Essa é uma opção que o npm requer para impedir que alguém publique um pacote privado de forma não intencional.

Este exemplo armazena o segredo NPM_TOKEN na variável de ambiente NODE_AUTH_TOKEN. Quando a ação setup-node cria um arquivo .npmrc, ela faz referência ao token da variável de ambiente NODE_AUTH_TOKEN.

name: Publish Package to npmjs
on:
  release:
    types: [created]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      # Setup .npmrc file to publish to npm
      - uses: actions/setup-node@v2
        with:
          node-version: '16.x'
          registry-url: 'https://registry.npmjs.org'
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

No exemplo acima, a ação setup-node cria um arquivo .npmrc no executor com o conteúdo a seguir:

//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}
registry=https://registry.npmjs.org/
always-auth=true

Observe que você precisa definir o registry-url como https://registry.npmjs.org/ em setup-node para configurar corretamente suas credenciais.

Publicar pacotes em GitHub Package Registry

Cada vez que você criar uma nova versão, você poderá acionar um fluxo de trabalho para publicar o seu pacote. O fluxo de trabalho no exemplo abaixo é executado sempre que ocorre o evento versão com o tipo criado. O fluxo de trabalho publica o pacote em GitHub Package Registry se o teste de CI for aprovado.

Configurar o repositório de destino

Se você não fornecer a chave do repositório no seu arquivo package.json, GitHub Package Registry irá publicar um pacote no repositório de GitHub especificado no campo nome do arquivo package.json. Por exemplo, um pacote denominado @my-org/test é publicado no my-org/test repositório de GitHub.

No entanto, se você fornecer a chave repositório, o repositório nessa chave será usado como o registro de npm de destino para GitHub Package Registry. Por exemplo, publicar os resultados package.json abaixo em um pacote denominado my-amazing-package publicado no repositório octocat/meu-repo de GitHub.

{
  "name": "@octocat/my-amazing-package",
  "repository": {
    "type": "git",
    "url": "https://github.com/octocat/my-other-repo.git"
  },

Efetuar a autenticação no repositório de destino

Para realizar operações autenticadas no registro do GitHub Package Registry em seu fluxo de trabalho, você pode usar o GITHUB_TOKEN. O segredo GITHUB_TOKEN é definido como um token de acesso para o repositório toda vez que um trabalho de um fluxo de trabalho for iniciado. tem permissões de leitura e gravação para pacotes no repositório em que o fluxo de trabalho é executado. Para obter mais informações, consulteEfetuar a autenticação com o GITHUB_TOKEN".

Se você quiser publicar seu pacote em um repositório diferente, você deverá usar um token de acesso pessoal (PAT) que tenha permissão para escrever pacotes no repositório de destino. Para obter mais informações, consulte "Criar um token de acesso pessoal" e "Segredos criptografados".

Exemplo de fluxo de trabalho

Este exemplo armazena o segredo GITHUB_TOKEN na variável de ambiente NODE_AUTH_TOKEN. Quando a ação setup-node cria um arquivo .npmrc, ela faz referência ao token da variável de ambiente NODE_AUTH_TOKEN.

name: Publish package to GitHub Packages
on:
  release:
    types: [created]
jobs:
  build:
    runs-on: ubuntu-latest 
    steps:
      - uses: actions/checkout@v2
      # Setup .npmrc file to publish to GitHub Packages
      - uses: actions/setup-node@v2
        with:
          node-version: '16.x'
          registry-url: 'https://npm.pkg.github.com'
          # Defaults to the user or organization that owns the workflow file
          scope: '@octocat'
      - run: npm ci
      - run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

A ação setup-node cria um arquivo .npmrc no executor. Ao usar a entrada do escopo para a ação setup-node, o arquivo .npmrc incluirá o prefixo do escopo. Por padrão, a ação setup-node define o escopo no arquivo .npmrc na conta que contém esse arquivo do fluxo de trabalho.

//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}
@octocat:registry=https://npm.pkg.github.com
always-auth=true

Publicar pacotes usando o yarn

Se você usar o gerenciador de pacotes Yarn, você poderá instalar e publicar pacotes usando o Yarn.

name: Publish Package to npmjs
on:
  release:
    types: [created]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      # Setup .npmrc file to publish to npm
      - uses: actions/setup-node@v2
        with:
          node-version: '16.x'
          registry-url: 'https://registry.npmjs.org'
          # Defaults to the user or organization that owns the workflow file
          scope: '@octocat'
      - run: yarn
      - run: yarn publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}