Fazendo seu pacote passar no Travis

Por Julio em 04/09/2019

Quando você acessa um pacote no GitHub, muitas vezes você se depara com essas coisas verdinhas:

Essas coisas são chamadas distintivos (“badges”). Indo da esquerda para a direita: a primeira delas serve para garantir ao leitor que o pacote é instalável no Linux, a segunda serve para garantir que o pacote é instalável no Windows, e a terceira serve para garantir que o pacote está no CRAN. Esses distintivos dão maior confiabilidade ao pacote e é considerado como boa prática de programação.

Nesse post, vou discutir sobre o primeiro distintivo, e mostrar um exemplo de como você pode conseguir criá-la usando o pacote {usethis} e o serviço Travis.

O que é o Travis?

Travis é um serviço de integração contínua (Continuous Integration, CI), que automatiza a aplicação de um conjunto de testes do seu código. De forma muito simplificada, o Travis funciona assim:

  1. Você dá um push do seu código no GitHub
  2. O Travis pega seu novo código e testa ele numa nova máquina Linux, criada na hora.
  3. Se o teste der certo, o Travis permite que seu distintivo fique verde. Se não der certo, ele fica vermelho.

Se você não conhece muito de GitHub, dê uma olhada nesse post do Athos ou veja esse maravilhoso livro da Jenny Bryan

Mas algumas coisas precisam ser configuradas para que esses passos sejam de fato aplicados.

Para (1), é necessário que você i) tenha uma conta no serviço travis-ci, ii) dê permissão para que o Travis monitore seus repositórios do GitHub e iii) adicione o seu pacote no Travis para monitoramento. Você só precisa fazer (i) e (ii) uma vez.

Para (2), é necessário definir que testes você quer fazer. Por padrão, o R já tem uma rotina na documentação do Travis. O que essa rotina faz é passar o R CMD CHECK no seu pacote, que é basicamente o que seu pacote precisa passar para que seja aceito no CRAN.

Para (3), você precisa adicionar o distintivo do seu pacote corretamente no seu arquivo README.md. A melhor forma de fazer isso é utilizando a função usethis::use_travis()

Vídeo

Nesse vídeo, usei minha conta do GitHub e criei um pacote do zero usando o pacote usethis, vinculei ao Travis, e fiz ele dar build.

Detalhes

  • Se o seu pacote depende da instalação de bibliotecas em C++, como libpoppler, libgsl, entre outras, você precisará adicioná-las manualmente no seu arquivo .travis.yml. Acredito que a melhor forma de fazer isso é copiando de outros pacotes que já fizeram isso antes, como esse aqui que eu fiz algumas semanas atrás.
  • Você também pode fazer o mesmo trabalho para testar seu código no Windows. Para isso, uma alternativa legal é o AppVeyor.
  • Para testar seu pacote em múltiplas plataformas, principalmente quando for submeter seu pacote no CRAN, use o R-Hub.

É isso. Happy coding ;)

comments powered by Disqus

Nossa Newsletter

Uma vez por semana enviamos um e-mail para você não perder nenhum post da Curso-R. Avisamos também sempre que abrimos uma nova turma.