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

"pepr build --custom-image / --registry-info" appears to honor only "--registry-info" #1662

Closed
1 of 3 tasks
btlghrants opened this issue Jan 14, 2025 · 1 comment · Fixed by #1678
Closed
1 of 3 tasks
Assignees
Milestone

Comments

@btlghrants
Copy link
Collaborator

btlghrants commented Jan 14, 2025

Background

While working #1654 I discovered that when trying to set both the --custom-image and --registry-info flags, the resulting image string only reflected the content of the --registry-info flag; the content of the --custom-image option was nowhere to be found.

Is this expected behavior? I couldn't find any reference to it in the pepr build docs, so... maybe it lives somewhere else?

Suggest that this be investigated. Current behavior codified in (upcoming) integration test for the pepr build cli:

  • /integration/cli/build.registryinfo.test.ts : build > builds a module > using a custom registry > builds

DOD:

  • Adds examples to cli npx pepr build --help output for custom-image and registry-info options
  • Update the docs to show example results
  • Throw a build error when both flags are used

Definition of Done

  1. figure out whether this is a "real" error or just a matter of test setup / config, and
  2. fix the error (if it is one), or
  3. add a note to the pepr build output / docs stating which flags are non-collaborative.
@btlghrants btlghrants converted this from a draft issue Jan 14, 2025
@cmwylie19
Copy link
Collaborator

I believe this is intended, registryInfo if for creating a custom WASM image with a well defined name image = ${opts.registryInfo}/custom-pepr-controller:${cfg.pepr.peprVersion}`;. Custom image, it would then attempt to build the docker image.

-i, --custom-image, is just for setting a custom image in the deployments. like pepr:dev for example.

@cmwylie19 cmwylie19 added this to the v0.43.0 milestone Jan 15, 2025
@cmwylie19 cmwylie19 moved this from Questions to 📋 Backlog in Pepr Project Board Jan 15, 2025
@cmwylie19 cmwylie19 self-assigned this Jan 16, 2025
@cmwylie19 cmwylie19 moved this from 📋 Backlog to 🏗 In progress in Pepr Project Board Jan 16, 2025
github-merge-queue bot pushed a commit that referenced this issue Jan 21, 2025
## Description

Controls which build arguments are used together and adds docs

Lets hold off on this one to see if we can get the commits signed on PR
#1651 first. CC @tamirazrab

## Related Issue

Fixes #1662 
<!-- or -->
Relates to #

## Type of change

- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Other (security config, docs update, etc)

## Checklist before merging
- [x] Unit,
[Journey](https://github.com/defenseunicorns/pepr/tree/main/journey),
[E2E Tests](https://github.com/defenseunicorns/pepr-excellent-examples),
[docs](https://github.com/defenseunicorns/pepr/tree/main/docs),
[adr](https://github.com/defenseunicorns/pepr/tree/main/adr) added or
updated as needed
- [x] [Contributor Guide
Steps](https://docs.pepr.dev/main/contribute/#submitting-a-pull-request)
followed

---------

Signed-off-by: Case Wylie <[email protected]>
Co-authored-by: Barrett <[email protected]>
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Pepr Project Board Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants