From b5a3b6b38f4962cf32bdcdf392ee6ae6c787a500 Mon Sep 17 00:00:00 2001 From: Philipp Arndt <2f.mail@gmx.de> Date: Thu, 26 Sep 2024 10:12:35 +0200 Subject: [PATCH] docs: update help for decrypt/encrypt (#474) --- CHANGELOG.md | 5 +++++ scripts/commands/decrypt.sh | 6 +++--- scripts/commands/encrypt.sh | 4 ++-- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 71c29d1f..a3f47b43 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +### Fixes +- fix: examples in the help of encrypt/decrypt commands + ## [4.6.1] - 2024-08-09 ### Fixes diff --git a/scripts/commands/decrypt.sh b/scripts/commands/decrypt.sh index f729ac06..c9143dd0 100644 --- a/scripts/commands/decrypt.sh +++ b/scripts/commands/decrypt.sh @@ -4,7 +4,7 @@ set -euf dec_usage() { cat < +helm secrets [ OPTIONS ] decrypt [ -i ] [ --terraform ] Decrypt secrets @@ -13,11 +13,11 @@ It uses your gpg credentials to decrypt previously encrypted values file. You can use plain sops to decrypt specific files - https://github.com/getsops/sops Typical usage: - $ helm secrets dec secrets/project/secrets.yaml + $ helm secrets decrypt secrets/project/secrets.yaml # Decrypt file inline - $ helm secrets dec -i secrets/project/secrets.yaml + $ helm secrets decrypt -i secrets/project/secrets.yaml EOF } diff --git a/scripts/commands/encrypt.sh b/scripts/commands/encrypt.sh index 85e236b2..e4fad782 100644 --- a/scripts/commands/encrypt.sh +++ b/scripts/commands/encrypt.sh @@ -4,7 +4,7 @@ set -euf enc_usage() { cat < +helm secrets [ OPTIONS ] encrypt [ -i ] Encrypt secrets @@ -15,7 +15,7 @@ This allows you to first decrypt the file, edit it, then encrypt it again. You can use plain sops to encrypt - https://github.com/getsops/sops Example: - $ helm secrets enc + $ helm secrets encrypt $ git add $ git commit $ git push