Repolode
Enviar
peaceiris

peaceiris/actions-gh-pages

Uma GitHub Action que publica o resultado do build de um site estático em uma branch do GitHub Pages a partir do seu workflow.

Ver no GitHubSite
Estrelas
5,370
Forks
448
Issues abertas
95
Último commit
ontem

O que é?

Esta GitHub Action publica o conteúdo de um diretório de build, como ./public ou ./out, em uma branch usada pelo GitHub Pages — gh-pages por padrão. Ela funciona com qualquer gerador de sites estáticos que produza arquivos simples, incluindo Hugo, MkDocs, Gatsby, mdBook, Next.js, Nuxt e VuePress. Assim, você pode adicionar a etapa de deploy após a etapa de build em um workflow existente.

A autenticação pode ser feita com o GITHUB_TOKEN criado automaticamente para o repositório atual, uma chave SSH de deploy ou um personal access token. O token pessoal ou a chave de deploy são necessários para publicar em outro repositório usando a opção external_repository. Outras opções permitem definir a branch de destino e um subdiretório de destino, excluir arquivos, adicionar um arquivo CNAME, controlar o processamento do Jekyll, manter arquivos existentes, criar branches órfãs com force, definir o autor e a mensagem do commit e criar Git tags.

A action é executada em runners Linux, macOS e Windows e oferece suporte ao GitHub Enterprise Server a partir da versão 2.22.6.

Recursos principais

  • 01Publica qualquer diretório com o resultado do build de um site estático em uma branch do GitHub Pages.
  • 02Oferece suporte a GITHUB_TOKEN, chaves SSH de deploy e personal access tokens.
  • 03Permite publicar em um repositório externo separado.
  • 04Inclui opções para arquivos CNAME, desativar o processamento do Jekyll e excluir arquivos do deploy.
  • 05Permite manter arquivos existentes ou criar uma branch órfã com um único commit.
  • 06É executada em runners Linux, macOS e Windows.

Casos de uso

  • Publicar automaticamente um site de documentação feito com Hugo ou MkDocs a cada push para main.
  • Fazer deploy de uma exportação estática do Next.js ou Nuxt no GitHub Pages usando CI.
  • Publicar um site público a partir de um repositório privado usando um personal access token.
  • Agendar rebuilds e deploys regulares de um site gerado.

Início rápido

  1. 1

    Adicione o arquivo de workflow .github/workflows/gh-pages.yml e faça push para a branch padrão

  2. 2

    Use a etapa deploy para publicar o diretório de saída do build

    uses: peaceiris/actions-gh-pages@v4

Antes de usar

  • É necessário configurar as definições de Pages do repositório antes da primeira implantação com GITHUB_TOKEN.
  • São necessárias chaves de implantação para runners do Windows, pois a opção deploy_key não funciona neles.

Em coleções

Frameworks de teste e ferramentas de automação de testesGeradores de sites estáticos e ferramentas de documentação

Tópicos

#github-actions#github-pages#static-site#deployment#ci-cd#ssg#actions#gatsby#hugo#mdbook

Perguntas frequentes

O que é actions-gh-pages?
Uma GitHub Action que publica o resultado do build de um site estático em uma branch do GitHub Pages a partir do seu workflow. Esta GitHub Action publica o conteúdo de um diretório de build, como ./public ou ./out, em uma branch usada pelo GitHub Pages — gh-pages por padrão. Ela funciona com qualquer gerador de sites estáticos que produza arquivos simples, incluindo Hugo, MkDocs, Gatsby, mdBook, Next.js, Nuxt e VuePress. Assim, você pode adicionar a etapa de deploy após a etapa de build em um workflow existente.
actions-gh-pages é gratuito? Qual é a licença?
actions-gh-pages é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
actions-gh-pages ainda é mantido?
Manutenção ativa. O último commit de actions-gh-pages foi em 6 de nov. de 2026.
Para que posso usar actions-gh-pages?
Publicar automaticamente um site de documentação feito com Hugo ou MkDocs a cada push para main. Fazer deploy de uma exportação estática do Next.js ou Nuxt no GitHub Pages usando CI. Publicar um site público a partir de um repositório privado usando um personal access token. Agendar rebuilds e deploys regulares de um site gerado.
Como instalar actions-gh-pages?
Adicione o arquivo de workflow .github/workflows/gh-pages.yml e faça push para a branch padrão Use a etapa deploy para publicar o diretório de saída do build: uses: peaceiris/actions-gh-pages@v4
Onde consigo actions-gh-pages?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/peaceiris/actions-gh-pages

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados