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

Update input_step.md #2365

Merged
merged 4 commits into from
Aug 23, 2023
Merged

Update input_step.md #2365

merged 4 commits into from
Aug 23, 2023

Conversation

nsuma8989
Copy link
Contributor

Goal of this PR is to add a note to let users know that input step fields should not be used to pass secret information

@github-actions github-actions bot added the pipelines Pull requests that update content related to Pipelines label Aug 10, 2023
@buildkite-docs-bot
Copy link
Contributor

Preview URL: https://2365--bk-docs-preview.netlify.app

@nsuma8989
Copy link
Contributor Author

@mbelton-buildkite Please can you review this PR and share your feedback

@nsuma8989
Copy link
Contributor Author

@mbelton-buildkite Please can you review this PR and share your feedback

@mbelton-buildkite Gentle remainder on this review request

@@ -44,6 +44,8 @@ For an example pipeline, see the [Input step example pipeline](https://github.c

<a class="Docs__example-repo" href="https://github.com/buildkite/input-step-example"><span class="detail">:pipeline: Input Step Example Pipeline</span> <span class="repo">github.com/buildkite/input-step-example</span></a>

>📘 Input step should not be used to store sensitive information like secrets.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should use the warning format for this, and separate out a title from the body text. In the body, it would be good to add the reason why you shouldn't do this. Please correct this, but thinking something like:

Suggested change
>📘 Input step should not be used to store sensitive information like secrets.
>🚧 Don't store sensitive data in input steps
> You shouldn't use input steps to store sensitive information like secrets because the data is available in subsequent steps.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mbelton-buildkite Updated with suggestion but with slight modification to see data will be stored in build metadata

@nsuma8989 nsuma8989 merged commit 057c4f1 into main Aug 23, 2023
1 check passed
@nsuma8989 nsuma8989 deleted the input-secret-note branch August 23, 2023 05:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pipelines Pull requests that update content related to Pipelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants