Add mask TOML secrets action #154
Conversation
lukaszcl
requested review from
tateexon,
kalverra,
skudasov,
AnieeG and
gheorghestrimtu
as code owners
lukaszcl
force-pushed
the
add-mask-toml-values-action
branch
from
712edf2
to
3106a69
Compare
|
@lukaszcl can we have a short readme.md that explains what it does? not everyone reads python |
|
@Tofel I added README. Also, the info how to use action is in the action.yml |
| To use this action in your workflow, follow the steps below: | ||
|
|
||
| 1. Ensure you have a Base64-encoded TOML configuration string that you wish to mask. The keys for any secrets in the TOML should end with `_secret`. | ||
| 2. Add a step in your GitHub Actions workflow to use this action. Do it **before** any other action related to the TOML |
There was a problem hiding this comment.
maybe give more examples?
- if that toml is user input, when should this action run?
- if that toml is generated in the workflow, when should this action run?
There was a problem hiding this comment.
if that toml is user input, when should this action run?
the action should run before you use TOML values. This is in the readme. Please say how would you want to update this text :)
if that toml is generated in the workflow, when should this action run?
This action does not care how you generate base64-encoded toml. You just have to pass it to the action if you want to mask keys with _secret suffix
There was a problem hiding this comment.
I meant: add it to the readme!
There was a problem hiding this comment.
I want to see specific examples for these 2 cases, readme is too abstract for me, I wouldn't be sure how to use that acitons in these 2 cases
|
This action will stay in https://github.com/smartcontractkit/mercury-pipeline repo until we are sure that we can use it across other repos. |
This introduces a GitHub action designed to mask TOML secrets within E2E test configs. This action has been successfully utilized in Mercury project over the past few months. I'm migrating it here for reusability.