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

docs: added docs for migrating encrypted secrets #30132

Merged
merged 24 commits into from
Jul 20, 2024

Conversation

justo-mend
Copy link
Contributor

Changes

Updated docs to show how to migrate encrypted secrets.

Context

Storing encrypted secrets in Renovate config is deprecated and will no longer be supported from 01-Sep-2024. New docs have been added to show how to migrate encrypted secrets from Renovate config to the App settings via the web UI.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

docs/usage/getting-started/app-secrets.md Show resolved Hide resolved
docs/usage/getting-started/app-secrets.md Outdated Show resolved Hide resolved
docs/usage/getting-started/migrating-secrets.md Outdated Show resolved Hide resolved
@justo-mend justo-mend requested a review from rarkins July 11, 2024 10:53
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed a whole lot! So please double check that the information is technically correct.

The docs has text about the confirmation box at the final step of importing a secret. It basically says that the reader should check the message carefully, to see if their secret is in "state A" or "state B". That kind of information must go in the confirmation box itself, in clear words.

At the end, as user you want to know:

  • Can Renovate see/use my secret now?
  • Is my secret still safe?
  • Is this what I expected to happen? If not, how can I get what I want?

The web UI should guide and help the user through the process. The docs are supporting material.

docs/usage/getting-started/app-secrets.md Outdated Show resolved Hide resolved
docs/usage/getting-started/app-secrets.md Outdated Show resolved Hide resolved
docs/usage/getting-started/app-secrets.md Outdated Show resolved Hide resolved
docs/usage/getting-started/app-secrets.md Outdated Show resolved Hide resolved
docs/usage/getting-started/app-secrets.md Outdated Show resolved Hide resolved
docs/usage/getting-started/migrating-secrets.md Outdated Show resolved Hide resolved
docs/usage/getting-started/migrating-secrets.md Outdated Show resolved Hide resolved
docs/usage/getting-started/migrating-secrets.md Outdated Show resolved Hide resolved
docs/usage/getting-started/private-packages.md Outdated Show resolved Hide resolved
docs/usage/getting-started/private-packages.md Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
rarkins
rarkins previously approved these changes Jul 20, 2024
@rarkins rarkins enabled auto-merge July 20, 2024 11:27
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixes for the lint errors.

docs/usage/getting-started/migrating-secrets.md Outdated Show resolved Hide resolved
docs/usage/getting-started/migrating-secrets.md Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
rarkins
rarkins previously approved these changes Jul 20, 2024
@rarkins
Copy link
Collaborator

rarkins commented Jul 20, 2024

@justo-mend in future please don't submit PRs from your main branch

@rarkins rarkins added this pull request to the merge queue Jul 20, 2024
Merged via the queue into renovatebot:main with commit 7ccebcc Jul 20, 2024
37 of 38 checks passed
@jamietanna
Copy link
Contributor

jamietanna commented Jul 20, 2024

FYI this has introduced a linting error into the docs on HEAD, just spotted it on my own PR!

Edit: fixed in #30275

@renovate-release
Copy link
Collaborator

🎉 This issue has been resolved in version 37.437.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants