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

Closed
wants to merge 24 commits into 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
Copy link
Contributor

woodpecker-bot commented Sep 10, 2024

Deployment of preview was successful: https://woodpecker-ci-woodpecker-pr-4099.surge.sh

@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
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/40-secrets.md Outdated Show resolved Hide resolved
docs/docs/20-usage/51-plugins/20-creating-plugins.md Outdated Show resolved Hide resolved
@lafriks
Copy link
Contributor

lafriks commented Sep 23, 2024

imho droping secrets and having only from_secret would make all less complicated 😅

@6543
Copy link
Member Author

6543 commented Sep 23, 2024

we depricated them and we could at least remove them from the docs ...

@pat-s
Copy link
Contributor

pat-s commented Sep 27, 2024

@6543 Do you still plan to address the points in my last review comment?

@6543
Copy link
Member Author

6543 commented Sep 27, 2024

Well as they are blocking yes ... when i have time

@6543
Copy link
Member Author

6543 commented Oct 2, 2024

image

@pat-s

@6543 6543 requested a review from pat-s November 5, 2024 13:49
@6543
Copy link
Member Author

6543 commented Nov 5, 2024

Deployment of preview was successful: https://woodpecker-ci-woodpecker-pr-4099.surge.sh

@pat-s
Copy link
Contributor

pat-s commented Nov 5, 2024

I'll take another look soon!

docs/docs/20-usage/40-secrets.md Outdated Show resolved Hide resolved
docs/docs/20-usage/40-secrets.md Outdated Show resolved Hide resolved
Comment on lines 26 to 32
- name: 'some commands using secrets'
image: bash
commands:
- env | grep TOKEN
+ environment:
+ TOKEN_ENV:
+ from_secret: secret_token
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- name: 'some commands using secrets'
image: bash
commands:
- env | grep TOKEN
+ environment:
+ TOKEN_ENV:
+ from_secret: secret_token
- name: 'step name'
image: registry/repo/image:tag
commands:
- env | grep TOKEN
+ environment:
+ TOKEN:
+ from_secret: secret_token

Copy link
Member Author

Choose a reason for hiding this comment

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

can not apply :/

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/versioned_docs/version-2.7/20-usage/40-secrets.md Outdated Show resolved Hide resolved
docs/versioned_docs/version-2.7/20-usage/40-secrets.md Outdated Show resolved Hide resolved
6543 and others added 8 commits November 7, 2024 12:34
Co-authored-by: Patrick Schratz <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <patrick.schratz@gmail.com>
@pat-s
Copy link
Contributor

pat-s commented Jan 5, 2025

Superseeded by #4644.

@pat-s pat-s closed this Jan 5, 2025
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.

4 participants