Skip to content

Commit

Permalink
chore: deprecate build version command in cli and docs before release (
Browse files Browse the repository at this point in the history
…#1762)

## Description

`build --version` command is not being used, we need to deprecate it
before the release so that we can remove it next release.

## Related Issue

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

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] 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 <cmwylie19@defenseunicorns.com>
Co-authored-by: Sam Mayer <sam.mayer@defenseunicorns.com>
  • Loading branch information
cmwylie19 and samayer12 authored Feb 4, 2025
1 parent 90ebb6a commit b3a5d7f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/030_user-guide/010_pepr-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Create a [zarf.yaml](https://zarf.dev) and K8s manifest for the current module.
- `--rbac-mode [admin|scoped]` - Rbac Mode: admin, scoped (default: admin) (choices: "admin", "scoped", default: "admin")
- `-i, --custom-image [custom-image]` - Specify a custom image (including version) for Admission and Watch Deployments. Example: 'docker.io/username/custom-pepr-controller:v1.0.0'
- `--registry [GitHub, Iron Bank]` - Container registry: Choose container registry for deployment manifests.
- `-v, --version <version>. Example: '0.27.3'` - The version of the Pepr image to use in the deployment manifests.
- `-v, --version <version>. Example: '0.27.3'` - DEPRECATED: The version of the Pepr image to use in the deployment manifests.
- `--withPullSecret <imagePullSecret>` - Image Pull Secret: Use image pull secret for controller Deployment.
- `-z, --zarf [manifest|chart]` - The Zarf package type to generate: manifest or chart (default: manifest).

Expand Down
4 changes: 2 additions & 2 deletions src/cli/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ export default function (program: RootCmd): void {
.addOption(
new Option(
"-v, --version <version>",
"The version of the Pepr image to use in the deployment manifests. Example: '0.27.3'.",
"DEPRECATED: The version of the Pepr image to use in the deployment manifests. Example: '0.27.3'.",
).conflicts(["customImage", "registryInfo"]),
)
.option(
Expand Down Expand Up @@ -164,7 +164,7 @@ export default function (program: RootCmd): void {
console.info(`✅ Module built successfully at ${path}`);
return;
}
// set the image version if provided
// set the image version if provided -- DEPRECATED
if (opts.version) cfg.pepr.peprVersion = opts.version;

// Generate a secret for the module
Expand Down

0 comments on commit b3a5d7f

Please sign in to comment.