Skip to main content

Inicie rapidamente para o GitHub Packages

Pulblique em GitHub Packages com GitHub Actions.

Observação: no momento, não há suporte para os executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.

Introdução

Neste guia, você criará um fluxo de trabalho de GitHub Actions para testar seu código e, em seguida, publicá-lo em GitHub Packages.

Publicar o seu pacote

  1. Crie um repositório no GitHub adicionando o .gitignore ao Node. Para obter mais informações, confira "Como criar um repositório".

  2. Clone o repositório em seu computador local.

    $ git clone https://YOUR-HOSTNAME/YOUR-USERNAME/YOUR-REPOSITORY.git
    $ cd YOUR-REPOSITORY
  3. Crie um arquivo index.js e adicione um alerta básico para dizer "Olá, mundo!"

    JavaScript
    console.log("Hello, World!");
  4. Inicialize um pacote npm com npm init. No assistente de inicialização do pacote, insira o pacote com o nome @YOUR-USERNAME/YOUR-REPOSITORY e defina o script de teste como exit 0. Isso vai gerar um arquivo package.json com informações sobre o pacote.

    $ npm init
      ...
      package name: @YOUR-USERNAME/YOUR-REPOSITORY
      ...
      test command: exit 0
      ...    
  5. Execute npm install para gerar o arquivo package-lock.json e faça commit e efetue push das alterações para o GitHub.

    $ npm install
    $ git add index.js package.json package-lock.json
    $ git commit -m "initialize npm package"
    $ git push
  6. Crie um diretório .github/workflows. Nesse diretório, crie um arquivo chamado release-package.yml.

  7. Copie o conteúdo YAML a seguir para o arquivo release-package.yml, substituindo YOUR-HOSTNAME pelo nome da sua empresa.

    YAML
    name: Node.js Package
    
    on:
      release:
        types: [created]
    
    jobs:
      build:
        runs-on: ubuntu-latest
        steps:
          - uses: actions/checkout@v2
          - uses: actions/setup-node@v2
            with:
              node-version: 16
          - run: npm ci
          - run: npm test
    
      publish-gpr:
        needs: build
        runs-on: ubuntu-latest
        permissions:
          packages: write
          contents: read
        steps:
          - uses: actions/checkout@v2
          - uses: actions/setup-node@v2
            with:
              node-version: 16
              registry-url: https://npm.YOUR-HOSTNAME.com/
          - run: npm ci
          - run: npm publish
            env:
              NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
  8. Diga ao NPM quais escopos e registros publicam pacotes usando um dos seguintes métodos:

    • Adicione um arquivo de configuração do npm ao repositório, criando um arquivo .npmrc no diretório raiz com o conteúdo:
      @YOUR-USERNAME:registry=https://npm.pkg.github.com
    • Edite o arquivo package.json e especifique a chave publishConfig:
      "publishConfig": {
         "@YOUR-USERNAME:registry": "https://npm.pkg.github.com"
       }
  9. Faça commit e faça push das suas alterações para 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
  10. O fluxo de trabalho que você criou será executado sempre que uma nova versão for criada no seu repositório. Se os testes passarem, o pacote será publicado em GitHub Packages.

    Para testar isso, procure a guia Código no repositório e crie uma versão. Para obter mais informações, confira "Como gerenciar as versões do repositório".

Visualizar o seu pacote publicado

Você pode ver todos os pacotes que você publicou.

  1. On your GitHub Enterprise Server instance, navigate to the main page of the repository. 1. À direita da lista de arquivos, clique em Pacotes. Link Pacotes na página de visão geral do repositório 1. Clique no nome do pacote que você deseja visualizar. Nome do pacote

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, confira "Como trabalhar com o registro npm".

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 Packages. 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 Packages 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 Packages e GitHub Actions: