bottlerocket-os/twoliter

Document using `bundle-modules = [ "go" ]` for Go packages that don't vendor dependencies

Aberta

#501 aberto em 30 de mai. de 2023

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Rust (43 forks)auto 404
help wanted

Métricas do repositório

Stars
 (34 estrelas)
Métricas de merge de PR
 (Mesclagem média 4d 18h) (19 fundiu PRs em 30d)

Description

What I'd like:

There currently isn't any good documentation on using bundle-modules = ["go"] for packages that are pulled in and don't vendor their own dependencies (like hotdog).

We should write up a snippet on using this system on the buildsys markdown so that package authors can reference it when building in new packages.

Any alternatives you've considered:

There is some documentation on this directly in the buildsys code:

https://github.com/bottlerocket-os/bottlerocket/blob/4b8a132fd34205408afb0683dd157f6856a50d13/tools/buildsys/src/manifest.rs#L36-L39

which was added as part of the initial feature add: https://github.com/bottlerocket-os/bottlerocket/pull/2378

But this should really be in the markdown docs itself since we can't expect package authors to read the buildsys code.

Guia do colaborador

Direção de pesquisa
Revise a documentação existente no markdown do buildsys e o comentário do código em tools/buildsys/src/manifest.rs. Entenda como `bundle modules` funciona para pacotes Go lendo o PR vinculado #2378. Em seguida, escreva um trecho claro explicando quando e como usar `bundle modules = ["go"]` para pacotes que não vendem dependências.
Pilha de tecnologia
gorust
Domain
build systemtooling
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80