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.

Quem pode usar esse recurso?

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

O GitHub Pages está disponível em repositórios públicos com o GitHub Free e o GitHub Free para organizações, e em repositórios públicos e privados com o GitHub Pro, o GitHub Team, o GitHub Enterprise Cloud e o GitHub Enterprise Server. Para mais informações, confira "Planos do 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 Enterprise Cloud oferece fluxos de trabalho iniciais para cenários comuns de publicação para ajudar vocâ a escrever seu fluxo de trabalho.

Aviso: a menos que sua empresa use Enterprise Managed Users, sites de GitHub Pages estarão disponíveis publicamente na Internet por padrão, mesmo que o repositório para o site seja privado ou interno. Você pode publicar um site de forma privada gerenciando o controle de acesso para o site. Caso contrário, se você tiver dados confidenciais no repositório do seu site, talvez queira remover os dados antes da publicação. Para obter mais informações, confira "Sobre repositórios" e "Alterar a visibilidade do site do GitHub Pages."

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 Enterprise Cloud, acesse o repositório do seu site.

  3. Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  4. Na seção "Código e automação" da barra lateral, clique em Páginas.

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

  6. Em "Compilação e implantação", no menu suspenso de branch, selecione uma fonte de publicação. Captura de tela das configurações do Pages em um repositório do GitHub. Há um menu "Nenhum" a fim de selecionar um branch para uma fonte de publicação com o contorno em laranja escuro.

  7. Opcionalmente, use o menu suspenso de pasta a fim de selecionar uma pasta para a fonte de publicação. Captura de tela das configurações do Pages em um repositório do GitHub. Há um menu "/(raiz)" a fim de selecionar uma pasta para uma fonte de publicação com o contorno em laranja escuro.

  8. Clique em Save (Salvar).

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

Note: If your repository contains symbolic links, you will need to publish your site using a GitHub Actions workflow. For more information about GitHub Actions, see "Documentação do GitHub Actions."

Observações:

  • 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.

  • Commits enviados por push por um fluxo de trabalho de GitHub Actions que usa o GITHUB_TOKEN não disparam um build de GitHub Pages.

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 "Solucionar problemas de erros de criação 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 "Visualizar 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 "Reexecutando fluxos de trabalho e trabalhos".

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 Enterprise Cloud, acesse o repositório do seu site.

  2. Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na seção "Código e automação" da barra lateral, clique em Páginas.

  4. Em "Build e implantação", em "Origem", selecione GitHub Actions .

  5. GitHub Enterprise Cloud 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 mais informações sobre GitHub Actions, confira "Documentação do GitHub Actions".

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

  1. Dispare sempre que houver um push para o branch padrão do repositório ou sempre que o fluxo de trabalho for executado manualmente na guia “Ações”.
  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 implantação para que apenas o branch padrão possa ser implantado nesse ambiente. Para obter mais informações, confira "Usando 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 do seu site do GitHub Pages" e "Pontos de extremidade da API REST para o GitHub 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 monitoramento e solução de problemas".