Trabalhando com o repositório npm

Limites para versões publicadas do npm

Se você publicar mais de 1.000 versões de pacote npm, GitHub Packagespoderá ver problemas de desempenho e tempos limite ocorrerem durante o uso.

No futuro, para melhorar o desempenho do serviço, você não poderá publicar mais de 1.000 versões de um pacote.GitHub Todas as versões publicadas antes de atingir esse limite serão legíveis.

Se você atingir este limite, considere excluir versões de pacote ou entre em contato com o suporte para obter ajuda. Quando este limite for aplicado, a nossa documentação será atualizada com uma forma de contorná-lo. Para obter mais informações, confira Excluir e restaurar um pacote ou Introdução ao GitHub Packages.

Autenticando para GitHub Packages

Você precisa de um token de acesso para publicar, instalar e excluir pacotes privados, públicos e internos.

Você pode usar um personal access token (classic) para se autenticar no GitHub Packages ou na API do GitHub. Ao criar um personal access token (classic), você pode atribuir diferentes escopos de token, dependendo da sua necessidade. Para obter mais informações sobre escopos relacionados a pacotes para personal access token (classic), confira Sobre permissões para o GitHub Packages.

Para efetuar a autenticação em um registro do GitHub Packages dentro de um fluxo de trabalho de GitHub Actions, você pode utilizar:

• GITHUB_TOKEN para publicar pacotes associados ao repositório do fluxo de trabalho.
• Um personal access token (classic) com pelo menos escopo read:packages para instalar pacotes associados a outros repositórios privados (GITHUB_TOKEN pode ser usado se o repositório receber acesso de leitura ao pacote. Confira, Configurando o controle de acesso e visibilidade de um pacote).

Autenticando com um personal access token

Você precisa usar um personal access token (classic) com os escopos apropriados para publicar e instalar pacotes no GitHub Packages. Para saber mais, confira Introdução ao GitHub Packages.

Você pode se autenticar no GitHub Packages com o npm, seja editando o arquivo ~/.npmrc do usuário para incluir o seu personal access token (classic), seja fazendo login no npm pela linha de comando usando seu nome de usuário e personal access token.

Para autenticar adicionando seu personal access token (classic) ao seu arquivo ~/.npmrc, edite o arquivo ~/.npmrc do seu projeto para incluir a seguinte linha, substituindo HOSTNAME pelo nome do host de sua instância do GitHub Enterprise Server e TOKEN pelo seu personal access token. Crie um arquivo ~/.npmrc se ele não existir.

Se sua instância tiver o isolamento de subdomínio habilitado:

//npm.HOSTNAME//:_authToken=TOKEN

Se sua instância tem o isolamento de subdomínio desabilitado:

//HOSTNAME/_registry/npm/:_authToken=TOKEN

Para se autenticar fazendo login no npm, use o comando npm login, substituindo USERNAME pelo seu nome de usuário do GitHub, TOKEN pelo seu personal access token (classic) e PUBLIC-EMAIL-ADDRESS pelo seu endereço de e-mail.

Se você estiver usando a CLI do npm versão 9 ou superior e entrando ou saindo de um registro privado usando a linha de comando, use a opção --auth-type=legacy para ler os detalhes da autenticação nos prompts em vez de usar o fluxo de logon padrão em um navegador. Para obter mais informações, consulte npm-login.

Se GitHub Packages não for o registro de pacotes padrão para usar o npm e você quiser usar o comando npm audit, recomendamos usar a flag --scope com o namespace que hospeda o pacote (a conta pessoal ou a organização que possui o repositório onde o pacote está hospedado) ao se autenticar no GitHub Packages.

Se sua instância tiver o isolamento de subdomínio habilitado:

$ npm login --scope=@NAMESPACE --auth-type=legacy --registry=https://npm.HOSTNAME/

> Username: USERNAME
> Password: TOKEN

Se sua instância tem o isolamento de subdomínio desabilitado:

$ npm login --scope=@NAMESPACE --auth-type=legacy --registry=https://HOSTNAME/_registry/npm/
> Username: USERNAME
> Password: TOKEN

Publicando um pacote

Os nomes e os escopos dos pacotes só podem usar letras minúsculas.

Por padrão, seu pacote é publicado no GitHub repositório especificado no name campo do package.json arquivo. Por exemplo, você publicaria um pacote nomeado @my-org/test para o my-org/testGitHub repositório. Você pode publicar vários pacotes no mesmo GitHub repositório incluindo um repository campo no package.json arquivo. Para obter mais informações, confira Como publicar vários pacotes no mesmo repositório.

Configure o mapeamento do escopo para seu projeto usando um arquivo .npmrc local no projeto ou usando a opção publishConfig em package.json. GitHub Packages só dá suporte a pacotes npm com escopo. Os pacotes com escopo têm nomes com o formato de @NAMESPACE/PACKAGE-NAME. Os pacotes com escopo sempre começam com um símbolo @. Talvez seja necessário atualizar o nome no package.json para usar o nome com escopo. Por exemplo, se você for o usuário octocat e seu pacote for nomeado test, você atribuirá o nome do pacote com escopo da seguinte maneira: "name": "@octocat/test".

Após publicar um pacote, você poderá visualizá-lo no GitHub. Para saber mais, confira Visualizar pacotes.

Publicando um pacote usando um arquivo .npmrc local

Use um arquivo .npmrc para configurar o mapeamento de escopo para o projeto. No arquivo .npmrc, use a URL GitHub Packages e o proprietário da conta para que GitHub Packages saiba para onde encaminhar solicitações de pacotes. O uso de um .npmrc arquivo impede que outros desenvolvedores publiquem acidentalmente o pacote para npmjs.org em vez de GitHub Packages.

1. Autenticar para GitHub Packages. Para saber mais, confira Autenticação no GitHub Packages.
2. No mesmo diretório do arquivo package.json, crie ou edite um arquivo .npmrc para incluir uma linha especificando a URL do GitHub Packages e o namespace no qual o pacote está hospedado. Substitua NAMESPACE pelo nome da conta de usuário ou organização , que é proprietário do repositório que contém seu projeto.

Se o isolamento de subdomínio estiver habilitado:

@NAMESPACE:registry=https://npm.HOSTNAME

Se o isolamento de subdomínio estiver desabilitado:

@NAMESPACE:registry=https://HOSTNAME/_registry/npm

1. Adicione o arquivo .npmrc ao repositório em que o GitHub Packages pode encontrar seu projeto. Para saber mais, confira Adicionar um arquivo a um repositório.

2. Verifique o nome do pacote no package.json do projeto. O campo name precisa conter o escopo e o nome do pacote. Por exemplo, se o seu pacote se chama "test" e você o está publicando na organização "My-org" GitHub, o campo name no seu package.json deve ser @my-org/test.

3. Verifique o campo repository no package.json do seu projeto. O campo repository deve corresponder à URL do repositório do GitHub. Por exemplo, se a URL do repositório for github.com/my-org/test, o campo de repositório deverá ser https://github.com/my-org/test.git.

4. Publicar um pacote:

   npm publish
   

Como publicar um pacote usando publishConfig no arquivo package.json

Use o elemento publishConfig no arquivo package.json para especificar o registro em que deseja publicar o pacote. Para obter mais informações, confira publishConfig na documentação do npm.

1. Edite o arquivo package.json do pacote e inclua uma entrada publishConfig.

   Se sua instância tiver o isolamento de subdomínio habilitado:

   "publishConfig": {
     "registry": "https://npm. HOSTNAME/"
   },
   

   Se sua instância tem o isolamento de subdomínio desabilitado:

   "publishConfig": {
     "registry": "https://HOSTNAME/_registry/npm/"
   },
   

2. Verifique o campo repository no package.json do seu projeto. O campo repository deve corresponder à URL do repositório do GitHub. Por exemplo, se a URL do repositório for github.com/my-org/test, o campo de repositório deverá ser https://github.com/my-org/test.git.

3. Publicar um pacote:

   npm publish
   

Publicar vários pacotes no mesmo repositório

Para publicar vários pacotes ao mesmo repositório, você pode incluir a URL do GitHub repositório no repository campo do package.json arquivo para cada pacote. Para obter mais informações, confira Criar um arquivo package.json e Criar módulos Node.js na documentação do npm.

Para garantir que a URL do repositório esteja correta, substitua REPOSITORY pelo nome do repositório que contém o pacote que você deseja publicar e OWNER pelo nome da conta pessoal ou organização que GitHub possui o repositório.

GitHub Packages corresponderá ao repositório com base na URL, em vez de com base no nome do pacote.

"repository":"https://HOSTNAME/OWNER/REPOSITORY",

Instalando um pacote

Você pode instalar pacotes a partir de GitHub Packages, adicionando os pacotes como dependências no arquivo package.json do seu projeto. Para obter mais informações sobre como usar um package.json no seu projeto, consulte Como trabalhar com package.json na documentação do npm.

Por padrão, você pode adicionar pacotes a partir de uma organização. Para obter mais informações, confira Como instalar pacotes de outras organizações.

Você também precisa adicionar o .npmrc arquivo ao seu projeto para que todas as solicitações para instalar pacotes passem GitHub Packages. Quando você roteia todas as solicitações de pacote por meio de GitHub Packages, pode usar pacotes com e sem escopo de npmjs.org. Para obter mais informações, consulte npm-scope na documentação do npm.

1. Autenticar para GitHub Packages. Para saber mais, confira Autenticação no GitHub Packages.
2. No mesmo diretório do arquivo package.json, crie ou edite um arquivo .npmrc para incluir uma linha especificando a URL do GitHub Packages e o namespace no qual o pacote está hospedado. Substitua NAMESPACE pelo nome da conta de usuário ou organização , que é proprietário do repositório que contém seu projeto.

Se o isolamento de subdomínio estiver habilitado:

@NAMESPACE:registry=https://npm.HOSTNAME

Se o isolamento de subdomínio estiver desabilitado:

@NAMESPACE:registry=https://HOSTNAME/_registry/npm

1. Adicione o arquivo .npmrc ao repositório em que o GitHub Packages pode encontrar seu projeto. Para saber mais, confira Adicionar um arquivo a um repositório.

2. Configure package.json no projeto para usar o pacote que você está instalando. Para adicionar as dependências do seu pacote ao arquivo package.json para GitHub Packages, especifique o nome completo do pacote com escopo, como @my-org/server. Para pacotes de npmjs.com, especifique o nome completo, como @babel/core ou lodash. Substitua ORGANIZATION_NAME/PACKAGE_NAME pela sua dependência de pacote.

   {
     "name": "@my-org/server",
     "version": "1.0.0",
     "description": "Server app that uses the ORGANIZATION_NAME/PACKAGE_NAME package",
     "main": "index.js",
     "author": "",
     "license": "MIT",
     "dependencies": {
       "ORGANIZATION_NAME/PACKAGE_NAME": "1.0.0"
     }
   }
   

3. Instale o pacote.

   npm install
   

Instalar pacotes de outras organizações

Por padrão, você só pode usar GitHub Packages pacotes de uma organização. Se você quiser rotear solicitações de pacote para várias organizações e usuários, poderá adicionar linhas adicionais ao arquivo.npmrc, substituindo HOSTNAME pelo nome do sua instância do GitHub Enterprise Server host eNAMESPACEpelo nome da conta pessoal ou organização que possui o repositório que contém o projeto.

Se sua instância tiver o isolamento de subdomínio habilitado:

@NAMESPACE:registry=https://npm.HOSTNAME
@NAMESPACE:registry=https://npm.HOSTNAME

Se sua instância tem o isolamento de subdomínio desabilitado:

@NAMESPACE:registry=https://HOSTNAME/_registry/npm
@NAMESPACE:registry=https://HOSTNAME/_registry/npm

Como usar o registro npm oficial

GitHub Packages permite que você acesse o registro registry.npmjs.comoficial do npm se o GitHub Enterprise Server administrador tiver habilitado esse recurso. Para obter mais informações, confira Como se conectar ao registro npm oficial.