|
59 | 59 |
|
60 | 60 | ## Inputs
|
61 | 61 |
|
62 |
| -- `secrets`: (Required) The list of secrets to access and inject into the |
| 62 | +<!-- BEGIN_AUTOGEN_INPUTS --> |
| 63 | +
|
| 64 | +- <a name="secrets"></a><a href="#user-content-secrets"><code>secrets</code></a>: _(Required)_ The list of secrets to access and inject into the |
63 | 65 | environment. Due to limitations with GitHub Actions inputs, this is
|
64 | 66 | specified as a string.
|
65 | 67 |
|
@@ -87,39 +89,43 @@ jobs:
|
87 | 89 | <project-id>/<secret-id>
|
88 | 90 | ```
|
89 | 91 |
|
90 |
| -- `min_mask_length`: (Optional, default: "4") Minimum line length for a secret |
91 |
| - to be masked. Extremely short secrets (e.g. "{" or "a") can make GitHub |
92 |
| - Actions log output unreadable. This is especially important for multi-line |
93 |
| - secrets, since each line of the secret is masked independently. |
| 92 | +- <a name="min_mask_length"></a><a href="#user-content-min_mask_length"><code>min_mask_length</code></a>: _(Optional, default: `4`)_ Minimum line length for a secret to be masked. Extremely short secrets |
| 93 | + (e.g. `{` or `a`) can make GitHub Actions log output unreadable. This is |
| 94 | + especially important for multi-line secrets, since each line of the secret |
| 95 | + is masked independently. |
| 96 | + |
| 97 | +- <a name="export_to_environment"></a><a href="#user-content-export_to_environment"><code>export_to_environment</code></a>: _(Optional)_ Make the fetched secrets additionally available as environment variables. |
| 98 | + |
| 99 | + |
| 100 | +<!-- END_AUTOGEN_INPUTS --> |
94 | 101 |
|
95 | 102 |
|
96 | 103 | ## Outputs
|
97 | 104 |
|
98 |
| -Each secret is prefixed with an output name. The secret's resolved access value |
99 |
| -will be available at that output in future build steps. |
| 105 | +<!-- BEGIN_AUTOGEN_OUTPUTS --> |
100 | 106 |
|
101 |
| -For example: |
| 107 | +- `secrets`: Each secret is prefixed with an output name. The secret's resolved access |
| 108 | + value will be available at that output in future build steps. For example: |
102 | 109 |
|
103 |
| -```yaml |
104 |
| -jobs: |
105 |
| - job_id: |
106 |
| - steps: |
107 |
| - - id: 'secrets' |
108 |
| - uses: 'google-github-actions/get-secretmanager-secrets@v2' |
109 |
| - with: |
110 |
| - secrets: |- |
111 |
| - token:my-project/docker-registry-token |
112 |
| -``` |
| 110 | + ```yaml |
| 111 | + jobs: |
| 112 | + job_id: |
| 113 | + steps: |
| 114 | + - id: 'secrets' |
| 115 | + uses: 'google-github-actions/get-secretmanager-secrets@v2' |
| 116 | + with: |
| 117 | + secrets: |- |
| 118 | + token:my-project/docker-registry-token |
| 119 | + ``` |
113 | 120 |
|
114 |
| -will be available in future steps as the output "token": |
| 121 | + will be available in future steps as the output: |
115 | 122 |
|
116 |
| -```yaml |
117 |
| -# other step |
118 |
| -- id: 'publish' |
119 |
| - uses: 'foo/bar@v1' |
120 |
| - env: |
121 |
| - TOKEN: '${{ steps.secrets.outputs.token }}' |
122 |
| -``` |
| 123 | + ```text |
| 124 | + steps.secrets.outputs.token |
| 125 | + ``` |
| 126 | + |
| 127 | + |
| 128 | +<!-- END_AUTOGEN_OUTPUTS --> |
123 | 129 |
|
124 | 130 |
|
125 | 131 | ## Authorization
|
|
0 commit comments