bottlerocket-os/twoliter

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

Open

#501 opened on May 30, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Rust (43 forks)auto 404
help wanted

Repository metrics

Stars
 (34 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Review the existing documentation in buildsys markdown and the code comment in tools/buildsys/src/manifest.rs. Understand how `bundle modules` works for Go packages by reading the linked PR #2378. Then write a clear snippet explaining when and how to use `bundle modules = ["go"]` for packages that do not vendor dependencies.
Tech stack
gorust
Domain
build systemtooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80