Inicie rapidamente para o GitHub Packages

Introdução

Você só precisa de um repositório de GitHub existente para publicar um pacote em GitHub Package Registry. Neste guia, você criará um fluxo de trabalho de GitHub Actions para testar seu código e, em seguida, publicá-lo em GitHub Package Registry. Sinta-se à vontade para criar um novo repositório para esse guia de início rápido. Você pode usá-lo para testar este e os fluxos de trabalho futuros de GitHub Actions.

Publicar o seu pacote

1. Crie um novo repositório em GitHub, adicionando o .gitignore ao Node. Crie um repositório privado, se quiser excluir este pacote mais tarde. Os pacotes públicos não podem ser excluídos. Para obter mais informações, consulte "Criar um novo repositório."

2. Clone o repositório para a sua máquina local.

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

3. Crie um arquivo index.js e adicione um alerta básico que diga "Hello world!"

   JavaScript

   alert("Hello, World!");

4. Inicializa um pacote de npm. No assistente de inicialização de pacote, insira seu pacote com o nome: @YOUR-USERNAME/YOUR-REPOSITORY e defina o script de teste para exit 0 se você não tiver testes. Faça o commit das alterações e envie-as por push para GitHub.

   <pre><code class="hljs language-shell">$ npm init
     ...
     package name: <em>@YOUR-USERNAME/YOUR-REPOSITORY</em>
     ...
     test command: <em>exit 0</em>
     ...
   
   $ npm install
   $ git add index.js package.json package-lock.json
   $ git commit -m "initialize npm package"
   $ git push</code></pre>
   

5. Do seu repositório no GitHub, crie um novo arquivo no diretório .github/workflows denominado release-package.yml. Para obter mais informações, consulte "Criar arquivos".

6. Copie o seguinte conteúdo do YAML para o arquivo release-package.yml.

   YAML

   name: Node.js Package
   
   on:
     release:
       types: [created]
   
   jobs:
     build:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v2
         - uses: actions/setup-node@v1
           with:
             node-version: 12
         - run: npm ci
         - run: npm test
   
     publish-gpr:
       needs: build
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v2
         - uses: actions/setup-node@v1
           with:
             node-version: 12
             registry-url: https://npm.pkg.github.com/
         - run: npm ci
         - run: npm publish
           env:
             NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

7. Vá até o final da página e selecione Criar um novo branch para este commit e iniciar um pull request. Em seguida, para criar um pull request, clique em Propor novo arquivo.

8. Faça merge do pull request.

9. Acesse a aba Código e crie uma nova versão para testar o fluxo de trabalho. Para obter mais informações, consulte "Gerenciando versões em um repositório."

A criação uma nova versão no seu repositório aciona o fluxo de trabalho para construir e testar seu código. Se os testes passarem, o pacote será publicado em GitHub Package Registry.

Visualizar o seu pacote publicado

Os pacotes são publicados no nível de repositório. Você pode visualizar todos os pacotes em um repositório e procurar um pacote específico.

1. No GitHub, navegue até a página principal do repositório.

2. À direita da lista de arquivos, clique em Packages (Pacotes).

   

3. Clique no nome do pacote que você deseja visualizar.

   

Instalar um pacote publicado

Agora que você publicou o pacote, você vai querer usá-lo como uma dependência nos seus projetos. Para obter mais informações, consulte "Configurar npm para uso com o GitHub Package Registry".

Próximas etapas

O fluxo de trabalho básico que você acabou de adicionar é executado sempre que uma nova versão for criada no seu repositório. Mas este é apenas o início do que você pode fazer com GitHub Package Registry. Pode publicar o seu pacote em vários registros com um único fluxo de trabalho, acionar o fluxo de trabalho para ser executado em eventos diferentes, como um pull request mesclado, gerenciar contêineres, entre outros.

Combinar GitHub Package Registry e GitHub Actions pode ajudá-lo a automatizar quase todos os aspectos dos processos de desenvolvimento do seu aplicativo. Pronto para começar? Aqui estão alguns recursos úteis para dar seguir as próximas etapas com GitHub Package Registry e GitHub Actions:

• "Aprenda sobre GitHub Package Registry" para obter um tutorial aprofundado no GitHub Packages
• "Aprenda sobre GitHub Actions" para obter um tutorial aprofundado no GitHub Actions
• "Guias" para casos e exemplos específicos de uso