Trabalhando com o registro do RubyGems

Note

Talvez esse tipo de pacote não esteja disponível para sua instância, pois os administradores do site podem habilitar ou desabilitar cada tipo de pacote compatível. Para obter mais informações, confira "Configurar o suporte ao ecossistema de pacote para sua empresa".

Pré-requisitos

Você deve ter o RubyGems 2.4.1 ou superior. Para encontrar a versão do seu RubyGems:
```
gem --version
```
Você precisa ter o Bundler 1.6.4 ou superior. Para encontrar sua versão do Bundler:
```
$ bundle --version
Bundler version 1.13.7
```

Autenticar-se no GitHub Packages

Note

O GitHub Packages dá suporte apenas à autenticação que usa um personal access token (classic). Para obter mais informações, confira "Gerenciar seus tokens de acesso pessoal".

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 Enterprise Server. 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 (que não podem ser acessados por GITHUB_TOKEN).

Autenticar 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 obter mais informações, confira "Introdução ao GitHub Packages".

Para publicar e instalar gems, você pode configurar o RubyGems ou o Bundler para se autenticar no GitHub Packages usando seu personal access token.

Para publicar novos gems, você precisa se autenticar no GitHub Packages com o RubyGems editando o arquivo ~/.gem/credentials para incluir seu personal access token (classic). Crie um arquivo ~/.gem/credentials se ele não existir.

Por exemplo, crie ou edite um arquivo ~/.gem/credentials para incluir o conteúdo indicado a seguir, substituindo TOKEN pelo seu personal access token.

---
:github: Bearer TOKEN

Para instalar gems, você precisa se autenticar em GitHub Packages atualizando suas fontes de gem para incluir https://USERNAME:TOKEN@REGISTRY_URL/NAMESPACE/. Você deve substituir:

USERNAME pelo seu nome de usuário do GitHub.
TOKEN com seu personal access token (classic).
NAMESPACE pelo nome da conta pessoal ou organização , que é proprietário do repositório que contém o gem.
REGISTRY_URL pela URL do registro do RubyGems da instância. Se a sua instância tem o isolamento de subdomínio habilitado, use rubygems.HOSTNAME. Se a sua instância tem o isolamento de subdomínio desabilitado, use HOSTNAME/_registry/rubygems. Em ambos os casos, substitua HOSTNAME pelo nome do host da sua instância do GitHub Enterprise Server.

Se você quiser que seu pacote esteja disponível globalmente, execute o comando a seguir para adicionar seu registro como uma fonte.

gem sources --add https://USERNAME:TOKEN@REGISTRY_URL/NAMESPACE/

Para se autenticar no Bundler, configure-o para usar seu personal access token (classic), substituindo USERNAME pelo seu nome de usuário do GitHub, TOKEN pelo seu personal access token e NAMESPACE pelo nome da conta pessoal ou organização , que é o proprietário do repositório que contém o gem. Substitua REGISTRY_URL pela URL do Registro do RubyGems da instância. Se a sua instância tem o isolamento de subdomínio habilitado, use rubygems.HOSTNAME. Se a sua instância tem o isolamento de subdomínio desabilitado, use HOSTNAME/_registry/rubygems. Em ambos os casos, substitua HOSTNAME pelo nome do host da sua instância do GitHub Enterprise Server.

bundle config https://REGISTRY_URL/NAMESPACE USERNAME:TOKEN

Publicando um pacote

Por padrão, o GitHub publica o pacote em um repositório existente com o mesmo nome do pacote. Por exemplo, quando você publica GEM_NAME na organização octo-org, os Pacotes do GitHub publicam o gem no repositório octo-org/GEM_NAME. Para obter mais informações sobre como criar seu gem, confira Como criar um gem própria na documentação do RubyGems.

Autenticar para GitHub Packages. Para obter mais informações, confira "Autenticação no GitHub Packages".
Compile o pacote do gemspec para criar o pacote .gem. Substitua GEM_NAME pelo nome da sua joia.
```
gem build GEM_NAME.gemspec
```
Publique um pacote no GitHub Packages, substituindo NAMESPACE pelo nome da conta pessoal ou organização , que é proprietário do repositório que contém seu projeto e GEM_NAME pelo nome do pacote do gem. Substitua REGISTRY_URL pela URL do Registro do RubyGems da sua instância. Se a sua instância tem o isolamento de subdomínio habilitado, use rubygems.HOSTNAME. Se a sua instância tem o isolamento de subdomínio desabilitado, use HOSTNAME/_registry/rubygems. Nos dois casos, substitua HOSTNAME pelo nome do host da instância do GitHub Enterprise Server.

Note

O tamanho máximo não compactado do arquivo metadata.gz de um gem precisa ser menor que 2 MB. Ocorrerá uma falha nas solicitações para efetuar push de gems que excedem esse limite.
```
$ gem push --key github \
--host https://REGISTRY_URL/NAMESPACE \
GEM_NAME-0.0.1.gem
```

Publicar vários pacotes no mesmo repositório

Para publicar vários gems no mesmo repositório, inclua a URL do repositório do GitHub no campo github_repo em gem.metadata. Se você incluir esse campo, o GitHub corresponderá ao repositório com base nesse valor, em vez de usar o nome do gem. Substitua HOSTNAME pelo nome do host da sua instância do GitHub Enterprise Server.

gem.metadata = { "github_repo" => "ssh://HOSTNAME/OWNER/REPOSITORY" }

Instalando um pacote

Você pode usar gems no GitHub Packages da mesma forma que você usa gems em rubygems.org. Você precisa se autenticar no GitHub Packages adicionando o usuário ou a organização do GitHub como uma fonte no arquivo ~/.gemrc ou usando o Bundler e editando o Gemfile.

Autenticar para GitHub Packages. Para obter mais informações, confira "Autenticação no GitHub Packages".
Para o Bundler, adicione o usuário ou a organização do GitHub como uma fonte no Gemfile para buscar gems dessa nova fonte. Por exemplo, você pode adicionar um novo bloco source ao Gemfile que só usa o GitHub Packages para os pacotes especificados, substituindo GEM_NAME pelo pacote que deseja instalar por meio do GitHub Packages e NAMESPACE pela conta pessoal ou organização , que é proprietário do repositório que contém o gem que você deseja instalar. Substitua REGISTRY_URL pela URL do Registro do RubyGems da sua instância. Se a sua instância tem o isolamento de subdomínio habilitado, use rubygems.HOSTNAME. Se a sua instância tem o isolamento de subdomínio desabilitado, use HOSTNAME/_registry/rubygems. Nos dois casos, substitua HOSTNAME pelo nome do host da instância do GitHub Enterprise Server.
```
source "https://rubygems.org"

gem "rails"

source "https://REGISTRY_URL/NAMESPACE" do
  gem "GEM_NAME"
end
```
Para versões do Bundler anteriores à 1.7.0, adicione uma nova source global. Para obter mais informações sobre como usar o Bundler, confira a documentação em bundler.io.
```
source "https://REGISTRY_URL/NAMESPACE"
source "https://rubygems.org"

gem "rails"
gem "GEM_NAME"
```
Instale o pacote:
```
gem install GEM_NAME --version "0.1.1"
```

Leitura adicional

Excluir e restaurar um pacote