Skip to main content

Configurar uma fonte de publicação para o site do GitHub Pages

Você pode configurar seu site do GitHub Pages para ser publicado quando alterações são enviadas por push a um branch específico ou pode escrever um fluxo de trabalho do GitHub Actions para publicar seu site.

Who can use this feature

People with admin or maintainer permissions for a repository can configure a publishing source for a GitHub Pages site.

GitHub Pages está disponível em repositórios públicos com GitHub Free e GitHub Free para organizações, e em repositórios públicos e privados com GitHub Pro, GitHub Team, GitHub Enterprise Cloud e GitHub Enterprise Server. Para obter mais informações, confira "produtos de GitHub".

Sobre as fontes de publicação

Você pode publicar seu site quando as alterações são enviadas por push para um branch específico ou você pode escrever um fluxo de trabalho do GitHub Actions para publicar seu site.

Se você não precisar de nenhum controle sobre o processo de build do seu site, recomendamos que você publique seu site quando as alterações forem enviadas por push para um branch específico. Você pode especificar qual branch e pasta usar como fonte de publicação. O branch de origem pode ser qualquer branch em seu repositório, e a pasta de origem pode ser a raiz do repositório (/) no branch de origem ou uma pasta /docs no branch de origem. Sempre que as alterações forem enviadas por push para o branch de origem, as alterações na pasta de origem serão publicadas em seu site do GitHub Pages.

Se você deseja usar um processo de build diferente do Jekyll ou não quer que um branch dedicado mantenha seus arquivos estáticos compilados, recomendamos que você escreva um fluxo de trabalho do GitHub Actions para publicar seu site. GitHub oferece fluxos de trabalho iniciais para cenários comuns de publicação para ajudar vocâ a escrever seu fluxo de trabalho.

Aviso: sites GitHub Pages estão disponíveis publicamente na Internet, mesmo que o repositório do site seja privado. Se você tiver dados confidenciais no repositório do seu site, você poderá removê-los antes de publicá-los. Para obter mais informações, confira "Sobre os repositórios".

Fazer publicação de um branch

  1. Verifique se o branch que você deseja usar como fonte de publicação já existe no repositório.

  2. Em GitHub, acesse o repositório do seu site. 1. Abaixo do nome do repositório, clique em Configurações. Botão Configurações do repositório

  3. In the "Code and automation" section of the sidebar, click Pages.

  4. Em "Build e implantação", em "Fonte", selecione Fazer implantação de um branch.

  5. Em "Build e implantação", em "Branch", use o menu suspenso Nenhum ou Branch e selecione uma fonte de publicação.

    Menu suspenso usado para selecionar uma fonte de publicação

  6. Opcionalmente, use o menu suspenso para selecionar uma pasta para sua fonte de publicação. Menu suspenso usado para selecionar uma pasta para a fonte de publicação

  7. Clique em Salvar. Botão usado para salvar as alterações nas configurações da fonte de publicação

Solução de problemas de publicação de um branch

Observação: se você estiver publicando de um branch e seu site não tiver sido publicado automaticamente, verifique se alguém com permissões de administrador e um endereço de email verificado efetuou push para a fonte de publicação.

Se você escolher a pasta docs em qualquer branch como a origem de publicação e, depois, remover a pasta /docs desse branch no repositório, seu site não será compilado e você receberá uma mensagem de erro de build de página para uma pasta /docs ausente. Para obter mais informações, confira "Solução de problemas de erros de build do Jekyll para sites do GitHub Pages".

O seu sitede GitHub Pages será sempre implantado com a execução de um fluxo de trabalho GitHub Actions, mesmo que você tenha configurado seu site GitHub Pages para ser criado usando uma ferramenta de CI diferente. A maioria dos fluxos de trabalho de CI externos é "implantada" no GitHub Pages pelo commit da saída de build no branch gh-pages do repositório e, geralmente, inclui um arquivo .nojekyll. Quando isso acontecer, o fluxo de trabalho do GitHub Actions detectará o estado de que o branch não precisa de uma etapa de build e executará apenas as etapas necessárias para implantar o site em servidores do GitHub Pages.

Para encontrar possíveis erros com a compilação ou implantação, você pode verificar a execução do fluxo de trabalho para o seu site de GitHub Pages revisando a execução do fluxo de trabalho do seu repositório. Para obter mais informações, confira "Como ver o histórico de execução do fluxo de trabalho". Para obter mais informações sobre como executar novamente o fluxo de trabalho em caso de erro, confira "Como executar fluxos de trabalho e trabalhos novamente".

Fazer publicação com um fluxo de trabalho personalizado de GitHub Actions

Observação: a publicação do seu site do GitHub Pages com um fluxo de trabalho de GitHub Actions personalizado está em versão beta e sujeita a alteração.

Para configurar seu site para publicar com GitHub Actions:

  1. Em GitHub, acesse o repositório do seu site. 1. Abaixo do nome do repositório, clique em Configurações. Botão Configurações do repositório

  2. In the "Code and automation" section of the sidebar, click Pages.

  3. Em "Build e implantação", em "Fonte", selecione GitHub Actions.

  4. GitHub sugerirá vários fluxos de trabalho iniciais. Se você já tiver um fluxo de trabalho para publicar seu site, poderá ignorar esta etapa. Caso contrário, escolha uma das opções para criar um fluxo de trabalho de GitHub Actions. Para obter mais informações sobre como criar seu fluxo de trabalho personalizado, confira "Como criar um fluxo de trabalho personalizado de GitHub Actions para publicar seu site."

    GitHub Pages não associa um fluxo de trabalho específico às configurações de GitHub Pages. No entanto, as configurações de GitHub Pages serão vinculadas à execução de fluxo de trabalho que implantou seu site mais recentemente.

Criar um fluxo de trabalho de GitHub Actions para publicar seu site

Para obter mais informações sobre GitHub Actions, confira "Ações."

Quando você configurar seu site para ser publicado com GitHub Actions, GitHub vai sugerir fluxos de trabalho iniciais para cenários de publicação comuns. O fluxo geral de um fluxo de trabalho é:

  1. Disparar sempre que houver um push para o branch padrão do repositório ou sempre que uma solicitação de pull direcionada ao branch padrão for aberta, reaberta ou atualizada.
  2. Usar a ação actions/checkout para conferir o conteúdo do repositório.
  3. Se exigido pelo seu site, crie arquivos de site estáticos.
  4. Usar a ação actions/upload-pages-artifact para carregar os arquivos estáticos como um artefato.
  5. Se o fluxo de trabalho foi disparado por um push para o branch padrão, use a ação actions/deploy-pages para implantar o artefato. Essa etapa será ignorada se o fluxo de trabalho tiver sido disparado por uma solicitação de pull.

Os fluxos de trabalho iniciais usam um ambiente de implantação chamado github-pages. Se o repositório ainda não incluir um ambiente chamado github-pages, o ambiente será criado automaticamente. Recomendamos que você adicione uma regra de proteção de ambiente para que apenas o branch padrão possa ser implantado nesse ambiente. Para obter mais informações, confira "Como usar ambientes para implantação".

Observação: um arquivo CNAME no seu arquivo de repositório não adiciona nem remove automaticamente um domínio personalizado. Em vez disso, você precisa configurar o domínio personalizado por meio das configurações do repositório ou por meio da API. Para obter mais informações, confira "Gerenciar um domínio personalizado para seu site do GitHub Pages" e a documentação de referência da API do Pages.

Solucionar problemas da publicação com um fluxo de trabalho personalizado de GitHub Actions

Para obter informações sobre como solucionar problemas do seu fluxo de trabalho de GitHub Actions, confira "Sobre o monitoramento e a solução de problemas".