Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jpmcb opened this issue May 30, 2023 · 0 comments
Labels
area/packaging Issues related to the packages bundled in Bottlerocket help wanted Denotes an issue that needs help from a contributor status/icebox Things we think would be nice but are not prioritized type/enhancement New feature or request

Comments

@jpmcb
Copy link
Contributor

jpmcb commented May 30, 2023

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:

The `bundle-*` keys on `external-files` are a group of optional modifiers
and are used to untar an upstream external file archive, vendor any dependent
code, and produce an additional archive with those dependencies.
Only `bundle-modules` is required when bundling an archive's dependences.

which was added as part of the initial feature add: #2378

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

@jpmcb jpmcb added type/enhancement New feature or request status/needs-triage Pending triage or re-evaluation labels May 30, 2023
@stmcginnis stmcginnis added help wanted Denotes an issue that needs help from a contributor status/icebox Things we think would be nice but are not prioritized area/packaging Issues related to the packages bundled in Bottlerocket and removed status/needs-triage Pending triage or re-evaluation labels Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/packaging Issues related to the packages bundled in Bottlerocket help wanted Denotes an issue that needs help from a contributor status/icebox Things we think would be nice but are not prioritized type/enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

2 participants