Template repositories not passing permissions or settings

[svanimisetti]

Select Topic Area

Question

Body

I am trying to create a private template repository in an org. When I create a new repo from this template using the "use this template" button on the top right, the new repo does not carry forward the settings or permission set for the template. Is there a way that I could force the settings and permissions to be carried forward to the new repo? The only other solution is to use GitHub API to reinstate the permissions/settings after repo creation.

[21hs]

Selecione a área do tópico

Pergunta

Corpo

Estou tentando criar um repositório de modelo privado em uma organização. Quando crio um novo repositório a partir deste modelo usando o botão "usar este modelo" no canto superior direito, o novo repositório não carrega as configurações ou permissões definidas para o modelo. Existe uma maneira de forçar as configurações e permissões a serem transportadas para o novo repositório? A única outra solução é usar a API do GitHub para restabelecer as permissões/configurações após a criação do repositório.

Infelizmente, o GitHub não oferece um mecanismo direto para que as configurações de um repositório modelo (como permissões, configurações de branch, webhooks e outras configurações personalizadas) sejam automaticamente transferidas para os repositórios criados a partir dele. Quando você cria um repositório novo usando um modelo, apenas o conteúdo e a estrutura do código do repositório são copiados, mas as configurações específicas não são.

Aqui estão algumas opções e soluções alternativas que você pode considerar:

1. Usar a API do GitHub para Configurar Após a Criação
   Como você mencionou, uma das maneiras de garantir que as permissões e configurações sejam configuradas corretamente no novo repositório é através da API do GitHub. Isso permite que você configure as permissões, branches protegidos, webhooks, e outras configurações que precisam ser replicadas.

Você pode usar os seguintes endpoints da API:

Repositórios para criar e modificar repositórios.
Colaboradores para adicionar permissões de colaboradores.
Branches protegidos para configurar as proteções de branch.
Webhooks para configurar webhooks.
Com esses endpoints, você pode escrever um script que automatize a configuração do novo repositório assim que ele for criado.

2. Usar GitHub Actions ou Scripts de Automação
   Outra solução seria criar um fluxo de trabalho automatizado usando o GitHub Actions ou outros sistemas de automação. Você pode configurar um GitHub Action que é acionado assim que um novo repositório é criado. Este fluxo de trabalho pode, então, configurar as permissões e as configurações necessárias, como adicionar colaboradores ou aplicar configurações específicas para o repositório.

Exemplo básico de fluxo de trabalho no GitHub Actions:

name: Configurar repositório após criação

on:
repository_dispatch:
types: [created]

jobs:
configurar-permissoes:
runs-on: ubuntu-latest
steps:
- name: Configurar permissões e proteções de branch
run: |
# Script para configurar permissões e outras configurações
curl -X PATCH -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}"
-d '{"permissions": {"push": "write", "pull": "read"}}'
https://api.github.com/repos/${{ github.repository }}/collaborators/username
Aqui, o fluxo seria acionado por um repository_dispatch que você pode disparar quando o repositório for criado (provavelmente via API, quando o repositório modelo for usado).

3. Documentar a Configuração Pós-Criação
   Embora não seja uma solução técnica automatizada, você pode documentar as etapas que devem ser seguidas para configurar o repositório após a criação. Isso pode incluir instruções para adicionar colaboradores, configurar branches protegidos, e outros aspectos críticos. Isso pode ajudar na padronização, mas não elimina a necessidade de intervenção manual.

4. Alternativa: Usar Ferramentas de Infraestrutura como Código
   Se você estiver confortável com ferramentas de infraestrutura como código (IaC), pode usar algo como Terraform ou GitHub CLI para criar e configurar repositórios com as permissões e configurações já estabelecidas. Terraform, por exemplo, pode automatizar a criação do repositório e definir as permissões de acesso e outras configurações, diretamente.

Conclusão
No momento, não há uma forma "nativa" no GitHub para forçar a transferência de configurações e permissões para repositórios criados a partir de um modelo. A melhor solução seria automatizar esse processo através da API do GitHub ou ferramentas de automação como o GitHub Actions ou Terraform.

[svanimisetti]

Thanks! This answer helps. I think using GitHub Actions in your solution 2 is the best option.