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

Clarify usage of secrets in docs #4099

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

6543
Copy link
Member

@6543 6543 commented Sep 10, 2024

@6543 6543 added documentation docu & docs enhancement improve existing features labels Sep 10, 2024
@woodpecker-bot

This comment was marked as outdated.

@6543 6543 requested a review from a team September 10, 2024 11:37
Copy link
Contributor

@pat-s pat-s left a comment

Choose a reason for hiding this comment

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

Thanks for the follow-up to my previous comment.

Besides the inline comments (which should be ported to the 2.7 docs if accepted), I am still missing a section which explains in detail:

  • why environment: has been removed from all plugins (and starting with which version)
  • how using secrets via a plugin setting option is different/more secure

docs/docs/20-usage/40-secrets.md Outdated Show resolved Hide resolved
docs/docs/20-usage/40-secrets.md Outdated Show resolved Hide resolved
docs/docs/20-usage/40-secrets.md Outdated Show resolved Hide resolved

### Use secrets in plugins via settings

The `from_secret` syntax also work for settings in any hierarchy.
Copy link
Contributor

Choose a reason for hiding this comment

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

Here we should add more information on why secrets cannot be used via environment: in plugins.

docs/docs/20-usage/40-secrets.md Outdated Show resolved Hide resolved
docs/docs/20-usage/40-secrets.md Outdated Show resolved Hide resolved
docs/docs/20-usage/40-secrets.md Outdated Show resolved Hide resolved
docs/docs/20-usage/51-plugins/20-creating-plugins.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation docu & docs enhancement improve existing features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants