Skip to content

Detailed controller installation instructions missing from releases and readme #1648

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.

Sign up for GitHub

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

Jump to bottom
Closed
agoddard opened this issue Dec 1, 2024 · 0 comments · Fixed by #1649
Closed

Detailed controller installation instructions missing from releases and readme #1648

agoddard opened this issue Dec 1, 2024 · 0 comments · Fixed by #1649

Comments

@agoddard
Copy link
Contributor

agoddard commented Dec 1, 2024

README.md shows helm installation instructions, but references the releases page for controller install instructions, however these cannot be found on the releases page:

sealed-secrets/README.md

Line 257 in 5d31d46

See https://github.com/bitnami-labs/sealed-secrets/releases for the latest release and detailed installation instructions.

agoddard added a commit to agoddard/sealed-secrets that referenced this issue Dec 1, 2024
@agoddard
re-introduce install instructions with to releases
1885a7b 
Installation instructions were included with releases until 0.16.0, but lost after that, perhaps with release automation moving to GitHub. These instructions are still referenced in the README.md as being available in Releases, so this PR reintroduces them.

Fixes bitnami-labs#1648


Signed-off-by: Anthony Goddard <[email protected]>
@agoddard agoddard mentioned this issue Dec 1, 2024
Merged
alvneiayu pushed a commit that referenced this issue Dec 5, 2024
@agoddard
re-introduce install instructions with to releases (#1649)
b497192 
Installation instructions were included with releases until 0.16.0, but
lost after that, perhaps with release automation moving to GitHub. These
instructions are still referenced in the README.md as being available in
Releases, so this PR reintroduces them.


**Description of the change**

Re-introduces installation instructions in Releases, as referenced by
README.md

**Benefits**

Maintain consistency with README instructions

**Possible drawbacks**

Splitting the instructions across multiple locations. It may be
preferred to move them to README.md, but automation will be required to
keep version numbers consistent.

**Applicable issues**

<!-- Enter any applicable Issues here (You can reference an issue using
#) -->
- fixes #1648 

**Additional information**

Install instructions were taken from those previously present in
Releases, as well as from existing README instructions for client
installs. There may be additional client installs or a change to the
preferred controller installation method which hasn't been considered
here.

Signed-off-by: Anthony Goddard <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

re-introduce install instructions with to releases agoddard/sealed-secrets
1 participant
@agoddard