Working with the RubyGems registry

Você pode configurar RubyGems para publicar um pacote em GitHub Package Registry e usar pacotes armazenados em GitHub Package Registry como dependências em um projeto Ruby com o Bundler.

GitHub Package Registry is available with GitHub Free, GitHub Pro, GitHub Free for organizations, GitHub Team, GitHub Enterprise Cloud, GitHub Enterprise Server, and GitHub AE.

Note: When installing or publishing a docker image, GitHub Package Registry does not currently support foreign layers, such as Windows images.

Pré-requisitos

  • Você deve ter o rubygems 2.4.1 ou superior. Para encontrar sua versão do rubygems:

    $ gem --version
    • Você deve ter o bundler 1.6.4 ou superior. Para encontrar sua versão do Bundler:

      $ bundle --version
      Bundler version 1.13.7
    • Instale o keycutter para gerenciar várias credenciais. Para instalar o keycutter:

      $ gem install keycutter

Autenticar-se no GitHub Package Registry

Você precisa de um token de acesso para publicar, instalar e excluir pacotes no GitHub Package Registry.

You can use a personal access token (PAT) to authenticate to GitHub Package Registry or the GitHub API. Ao criar um token de acesso pessoal, você pode atribuir diferentes escopos de token, dependendo da sua necessidade. For more information about packages-related scopes for a PAT, see "About permissions for GitHub Packages."

To authenticate to a GitHub Package Registry registry within a GitHub Actions workflow, you can use:

  • GITHUB_TOKEN to publish packages associated with the workflow repository.
  • a PAT to install packages associated with other private repositories (which GITHUB_TOKEN can't access).

For more information about GITHUB_TOKEN used in GitHub Actions workflows, see "Authentication in a workflow."

Efetuando a autenticação com um token de acesso pessoal

Você deve usar um token de acesso pessoal com os escopos apropriados para publicar e instalar pacotes no GitHub Package Registry. Para obter mais informações, consulte "Sobre GitHub Package Registry."

Você pode efetuar a autenticação em GitHub Package Registry com o RubyGems editando o arquivo ~/.gem/credentials para publicação de gems, editando o arquivo ~/.gemrc para instalar um único gem, ou usando o Bundler para rastrear e instalar um ou mais gems.

Para publicar novos gems, você precisa efetuar a autenticação no GitHub Package Registry com RubyGems, editando seu arquivo ~/.gem/credentials para incluir seu token de acesso pessoal. Crie um novo arquivo ~/.gem/credentials se este arquivo não existir.

Por exemplo, você criaria ou editaria um arquivo ~/.gem/credentials para incluir o indicado a seguir, substituindo TOKEN pelo seu token de acesso pessoal.

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

Para instalar gems, você deve efetuar a autenticação no GitHub Package Registry, editando o arquivo ~/.gemrc para o seu projeto incluir https://USERNAME:TOKEN@REGISTRY-URL/OWNER/. Você deve substituir:

  • NOME DE USUÁRIO pelo seu nome de usuário no GitHub.
  • TOKEN pelo seu token de acesso pessoal.
  • PROPRIETÁRIO com o nome da conta do usuário ou da organização que é proprietário do repositório que contém o seu projeto.
  • URL com a URL para o registro do Rubygems da sua instância. Se sua instância tiver o isolamento de subdomínio habilitado, use rubygems.HOSTNAME. Se a sua instância estiver com o isolamento de subdomínio desabilitado, use HOSTNAME/registry/rubygems. Em ambos os casos, substitua HOSTNAME pelo nome de host da sua instância do GitHub Enterprise Server.

Se você não tiver um arquivo ~/.gemrc, crie um arquivo ~/.gemrc usando este exemplo.

---
:backtrace: false
:bulk_threshold: 1000
:sources:
- https://rubygems.org/
- https://USERNAME:TOKEN@REGISTRY-URL/OWNER/
:update_sources: true
:verbose: true  

Para autenticar com o bundler, configure o Bundler para usar o seu token de acesso pessoal, substituindo USERNAME com seu GitHub nome de usuário, TOKEN com seu token de acesso pessoal, e OWNER com o nome do usuário ou conta da organização proprietária do repositório que contém o seu projeto. Substitua URL REGISTRO pelo URL do registro Rubygems da sua instância. Se sua instância tiver o isolamento de subdomínio habilitado, use rubygems.HOSTNAME. Se a sua instância estiver com o isolamento de subdomínio desabilitado, use HOSTNAME/registry/rubygems. Em ambos os casos, substitua HOSTNAME pelo nome de host da sua instância de GitHub Enterprise Server.

$ bundle config https://REGISTRY-URL/OWNER USERNAME:TOKEN

Publicar um pacote

Por padrão, o GitHub publica o pacote em um repositório existente com o mesmo nome do pacote. Por exemplo, ao publicar octo-gem na organização octo-org , GitHub Package Registry publicará o gem no repositório octo-org/octo-gem. Para obter mais informações sobre como criar seu gem, consulte "Criar seu próprio gem" na documentação do RubyGems.

Após publicar um pacote, você poderá visualizá-lo no GitHub. Para obter mais informações, consulte "Visualizar pacotes".

  1. Autenticar para GitHub Package Registry. Para obter mais informações, consulte "Authenticating to GitHub Package Registry."

  2. Crie o pacote da gemspec para criar o pacote .gem.

    gem build OCTO-GEM.gemspec
  3. Publicar um pacote em GitHub Package Registry, substituindo o OWNER pelo nome do usuário ou conta da organização proprietária do repositório que contém o seu projeto e OCTO-GEM pelo nome do seu pacote de gemas. substitui REGISTRY-URL pelo URL do registro Rubygems da sua instância. Se sua instância tiver o isolamento de subdomínio habilitado, use rubygems.HOSTNAME. Se a sua instância estiver com o isolamento de subdomínio desabilitado, use HOSTNAME/registry/rubygems. Em ambos os casos, substitua HOSTNAME pelo nome de host da sua instância de GitHub Enterprise Server.

    $ gem push --key github \
    --host https://REGISTRY-URL/OWNER \
    OCTO-GEM-0.0.1.gem

Publicar vários pacotes no mesmo repositório

Para publicar vários gems no mesmo repositório, você pode incluir a URL no repositório de GitHub no campo github_repo em gem.metadata. Se você incluir este campo, GitHub corresponderá ao repositório baseado neste valor, ao invés de usar o nome do gem. Substitua HOSTNAME pelo nome de host de sua instância do GitHub Enterprise Server.

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

Instalar um pacote

É possível usar gems do GitHub Package Registry assim como você usa gems de rubygems.org. You need to authenticate to GitHub Package Registry by adding your GitHub user or organization as a source in the ~/.gemrc file or by using Bundler and editing your Gemfile.

  1. Autenticar para GitHub Package Registry. Para obter mais informações, consulte "Authenticating to GitHub Package Registry."

  2. Para o Bundler, adicione seu usuário ou organização GitHub como uma fonte no seu Gemfile para buscar gems a partir desta nova fonte. Por exemplo, você pode adicionar um novo blocode fonteao seu Gemfile que usa GitHub Package Registry apenas para os pacotes que você especificar, substituindo GEM NOME pelo pacote que deseja instalar de GitHub Package Registry e OWNER pelo usuário ou organização que possui o repositório que contém a gema que deseja instalar. substitua URL REGISTRY pelo URL do registro Rubygems da sua instância. Se sua instância tiver o isolamento de subdomínio habilitado, use rubygems.HOSTNAME. Se a sua instância estiver com o isolamento de subdomínio desabilitado, use HOSTNAME/registry/rubygems. Em ambos os casos, substitua HOSTNAME pelo nome de host da sua instância de GitHub Enterprise Server.

    source "https://rubygems.org"
    
    gem "rails"
    
    source "https://REGISTRY-URL/OWNER" do
      gem "GEM NAME"
    end
    
  3. Para versões do Bundler anteriores à 1.7.0, você deve adicionar uma nova fonte global. Para obter mais informações sobre como usar o Bundler, consulte a documentação bundler.io.

    source "https://REGISTRY-URL/OWNER"
    source "https://rubygems.org"
    
    gem "rails"
    gem "GEM NAME"
    
  4. Instale o pacote:

    $ gem install octo-gem --version "0.1.1"

Leia mais

Esse documento ajudou você?Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.