Repolode
Enviar
JamesIves

JamesIves/github-pages-deploy-action

Uma action do GitHub Actions que compila e publica seu projeto automaticamente no GitHub Pages, enviando os arquivos gerados para qualquer branch, como gh-pages ou docs.

Ver no GitHubSite
Estrelas
4,613
Forks
447
Issues abertas
6
Último commit
há 4 dias

O que é?

A GitHub Pages Deploy Action é uma etapa do GitHub Actions que publica uma pasta do seu workflow, como o diretório de saída da compilação, no GitHub Pages. Você escolhe a branch de destino, incluindo gh-pages ou docs, e a action cria essa branch caso ela ainda não exista. Ela também oferece suporte a implantações entre repositórios e funciona com o GitHub Enterprise.

A action é configurada na seção `with` de um arquivo de workflow. A principal entrada obrigatória é `folder`, o diretório a ser publicado. As configurações opcionais incluem a branch de destino, a mensagem do commit, o autor do git, tokens personalizados ou chaves SSH de implantação e a opção de remover arquivos obsoletos da branch de implantação. Ela também pode ser executada em modo dry-run, consolidar o histórico em um único commit e disponibilizar uma saída `deployment-status` para etapas posteriores.

Ela foi criada para sites estáticos e outros projetos cujo conteúdo compilado possa ser servido a partir de uma branch. Por padrão, a action é executada no Ubuntu e precisa de permissão de escrita no conteúdo do repositório.

Recursos principais

  • 01Publica qualquer pasta em qualquer branch, incluindo gh-pages e docs.
  • 02Oferece suporte à implantação entre repositórios usando um personal access token.
  • 03Autentica com o GITHUB_TOKEN padrão, um PAT ou uma chave SSH de implantação.
  • 04Remove arquivos obsoletos da branch de implantação, preservando os arquivos excluídos da limpeza.
  • 05Oferece modo dry-run, histórico em um único commit e uma saída deployment-status.

Casos de uso

  • Publicar no GitHub Pages, após cada push, um site estático criado com um framework como React ou Vue.
  • Implantar em uma branch docs a documentação gerada por uma ferramenta de build.
  • Enviar o conteúdo compilado de um repositório para o site do Pages de outro repositório.
  • Implantar a partir de um job de build no Windows, passando os artifacts para um job de implantação no Ubuntu.

Início rápido

  1. 1

    Adicione um arquivo workflow que faça checkout do repositório, compile o site e o implante com a action

  2. 2

    Defina as permissões do workflow como contents: write e indique em folder o caminho da saída do build

  3. 3

    Nas configurações do repositório, escolha Pages, depois Deploy from a Branch e selecione a branch de deploy (geralmente gh-pages)

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#deployment#ci-cd#static-site#continuous-deployment#action#actions#cicd#continuous-delivery

Perguntas frequentes

O que é github-pages-deploy-action?
Uma action do GitHub Actions que compila e publica seu projeto automaticamente no GitHub Pages, enviando os arquivos gerados para qualquer branch, como gh-pages ou docs. A GitHub Pages Deploy Action é uma etapa do GitHub Actions que publica uma pasta do seu workflow, como o diretório de saída da compilação, no GitHub Pages. Você escolhe a branch de destino, incluindo gh-pages ou docs, e a action cria essa branch caso ela ainda não exista. Ela também oferece suporte a implantações entre repositórios e funciona com o GitHub Enterprise.
github-pages-deploy-action é gratuito? Qual é a licença?
github-pages-deploy-action é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
github-pages-deploy-action ainda é mantido?
Manutenção ativa. O último commit de github-pages-deploy-action foi em 2 de nov. de 2026.
Para que posso usar github-pages-deploy-action?
Publicar no GitHub Pages, após cada push, um site estático criado com um framework como React ou Vue. Implantar em uma branch docs a documentação gerada por uma ferramenta de build. Enviar o conteúdo compilado de um repositório para o site do Pages de outro repositório. Implantar a partir de um job de build no Windows, passando os artifacts para um job de implantação no Ubuntu.
Como instalar github-pages-deploy-action?
Adicione um arquivo workflow que faça checkout do repositório, compile o site e o implante com a action Defina as permissões do workflow como contents: write e indique em folder o caminho da saída do build Nas configurações do repositório, escolha Pages, depois Deploy from a Branch e selecione a branch de deploy (geralmente gh-pages)
Onde consigo github-pages-deploy-action?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/JamesIves/github-pages-deploy-action

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

Projetos relacionados