Skip to content

Commit 310f3cb

Browse files
authored
Prep 1.2.0 (#52)
* action: mark env var as internal explicitly Signed-off-by: William Woodruff <[email protected]> * README: prep 1.2.0 Signed-off-by: William Woodruff <[email protected]> --------- Signed-off-by: William Woodruff <[email protected]>
1 parent 607296a commit 310f3cb

File tree

3 files changed

+30
-30
lines changed

3 files changed

+30
-30
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
- uses: actions/checkout@v3
3030
- name: install
3131
run: python -m pip install .
32-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
32+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
3333
with:
3434
inputs: file.txt
3535
```
@@ -53,15 +53,15 @@ provided.
5353
To sign one or more files:
5454

5555
```yaml
56-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
56+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
5757
with:
5858
inputs: file0.txt file1.txt file2.txt
5959
```
6060

6161
The `inputs` argument also supports file globbing:
6262

6363
```yaml
64-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
64+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
6565
with:
6666
inputs: ./path/to/inputs/*.txt
6767
```
@@ -74,7 +74,7 @@ The `identity-token` setting controls the OpenID Connect token provided to Fulci
7474
workflow will use the credentials found in the GitHub Actions environment.
7575

7676
```yaml
77-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
77+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
7878
with:
7979
inputs: file.txt
8080
identity-token: ${{ IDENTITY_TOKEN }} # assigned elsewhere
@@ -90,7 +90,7 @@ Server during OAuth2.
9090
Example:
9191

9292
```yaml
93-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
93+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
9494
with:
9595
inputs: file.txt
9696
oidc-client-id: alternative-sigstore-id
@@ -106,7 +106,7 @@ Connect Server during OAuth2.
106106
Example:
107107

108108
```yaml
109-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
109+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
110110
with:
111111
inputs: file.txt
112112
oidc-client-secret: alternative-sigstore-secret
@@ -122,7 +122,7 @@ when signing multiple input files.
122122
Example:
123123

124124
```yaml
125-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
125+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
126126
with:
127127
inputs: file.txt
128128
signature: custom-signature-filename.sig
@@ -131,7 +131,7 @@ Example:
131131
However, this example is invalid:
132132

133133
```yaml
134-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
134+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
135135
with:
136136
inputs: file0.txt file1.txt file2.txt
137137
signature: custom-signature-filename.sig
@@ -147,7 +147,7 @@ work when signing multiple input files.
147147
Example:
148148

149149
```yaml
150-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
150+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
151151
with:
152152
inputs: file.txt
153153
certificate: custom-certificate-filename.crt
@@ -156,7 +156,7 @@ Example:
156156
However, this example is invalid:
157157

158158
```yaml
159-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
159+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
160160
with:
161161
inputs: file0.txt file1.txt file2.txt
162162
certificate: custom-certificate-filename.crt
@@ -172,7 +172,7 @@ when signing multiple input files.
172172
Example:
173173

174174
```yaml
175-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
175+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
176176
with:
177177
inputs: file.txt
178178
bundle: custom-bundle.sigstore
@@ -181,7 +181,7 @@ Example:
181181
However, this example is invalid:
182182

183183
```yaml
184-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
184+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
185185
with:
186186
inputs: file0.txt file1.txt file2.txt
187187
certificate: custom-bundle.sigstore
@@ -197,7 +197,7 @@ from. This setting cannot be used in combination with the `staging` setting.
197197
Example:
198198

199199
```yaml
200-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
200+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
201201
with:
202202
inputs: file.txt
203203
fulcio-url: https://fulcio.sigstage.dev
@@ -213,7 +213,7 @@ cannot be used in combination with the `staging` setting.
213213
Example:
214214

215215
```yaml
216-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
216+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
217217
with:
218218
inputs: file.txt
219219
rekor-url: https://rekor.sigstage.dev
@@ -229,7 +229,7 @@ in combination with the `staging` setting.
229229
Example:
230230

231231
```yaml
232-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
232+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
233233
with:
234234
inputs: file.txt
235235
ctfe: ./path/to/ctfe.pub
@@ -245,7 +245,7 @@ be used in combination with `staging` setting.
245245
Example:
246246

247247
```yaml
248-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
248+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
249249
with:
250250
inputs: file.txt
251251
ctfe: ./path/to/rekor.pub
@@ -261,7 +261,7 @@ instead of the default production instances.
261261
Example:
262262

263263
```yaml
264-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
264+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
265265
with:
266266
inputs: file.txt
267267
staging: true
@@ -284,7 +284,7 @@ and `verify-oidc-issuer` settings. Failing to pass these will produce an error.
284284
Example:
285285

286286
```yaml
287-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
287+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
288288
with:
289289
inputs: file.txt
290290
verify: true
@@ -307,7 +307,7 @@ This setting may only be used in conjunction with `verify-oidc-issuer`.
307307
Supplying it without `verify-oidc-issuer` will produce an error.
308308

309309
```yaml
310-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
310+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
311311
with:
312312
inputs: file.txt
313313
verify: true
@@ -332,7 +332,7 @@ Supplying it without `verify-cert-identity` will produce an error.
332332
Example:
333333

334334
```yaml
335-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
335+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
336336
with:
337337
inputs: file.txt
338338
verify: true
@@ -354,7 +354,7 @@ workflow artifact retention period is used.
354354
Example:
355355

356356
```yaml
357-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
357+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
358358
with:
359359
inputs: file.txt
360360
upload-signing-artifacts: true
@@ -382,7 +382,7 @@ permissions:
382382
383383
# ...
384384
385-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
385+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
386386
with:
387387
inputs: file.txt
388388
release-signing-artifacts: true
@@ -404,7 +404,7 @@ signing artifact is uploaded.
404404
Example:
405405

406406
```yaml
407-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
407+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
408408
with:
409409
inputs: file.txt
410410
upload-signing-artifacts: true
@@ -432,7 +432,7 @@ Example:
432432
Example:
433433

434434
```yaml
435-
- uses: sigstore/gh-action-sigstore-python@v1.1.0
435+
- uses: sigstore/gh-action-sigstore-python@v1.2.0
436436
with:
437437
inputs: file.txt
438438
internal-be-careful-debug: true

action.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ def _log(msg):
5656

5757

5858
def _download_ref_asset(ext):
59-
repo = os.getenv('GITHUB_REPOSITORY')
59+
repo = os.getenv("GITHUB_REPOSITORY")
6060
ref = os.getenv("GITHUB_REF")
6161

6262
artifact = Path(f"/tmp/{os.getenv('GITHUB_REF_NAME')}").with_suffix(ext)
@@ -264,8 +264,8 @@ def _fatal_help(msg):
264264
assert verify_status is None
265265
sys.exit(sign_status.returncode)
266266

267-
# Now populate the `GHA_SIGSTORE_PYTHON_SIGNING_ARTIFACTS` environment variable
268-
# so that later steps know which files to upload as workflow artifacts.
267+
# Now populate the `GHA_SIGSTORE_PYTHON_INTERNAL_SIGNING_ARTIFACTS` environment
268+
# variable so that later steps know which files to upload as workflow artifacts.
269269
#
270270
# In GitHub Actions, environment variables can be made to persist across
271271
# workflow steps by appending to the file at `GITHUB_ENV`.
@@ -276,7 +276,7 @@ def _fatal_help(msg):
276276
# {value}
277277
# {delimiter}
278278
gh_env.write(
279-
"GHA_SIGSTORE_PYTHON_SIGNING_ARTIFACTS<<EOF"
279+
"GHA_SIGSTORE_PYTHON_INTERNAL_SIGNING_ARTIFACTS<<EOF"
280280
+ os.linesep
281281
+ os.linesep.join(signing_artifact_paths)
282282
+ os.linesep

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,9 @@ runs:
139139
if: inputs.upload-signing-artifacts == 'true'
140140
with:
141141
name: "signing-artifacts-${{ github.job }}"
142-
path: "${{ env.GHA_SIGSTORE_PYTHON_SIGNING_ARTIFACTS }}"
142+
path: "${{ env.GHA_SIGSTORE_PYTHON_INTERNAL_SIGNING_ARTIFACTS }}"
143143

144144
- uses: softprops/action-gh-release@v1
145145
if: inputs.release-signing-artifacts == 'true' && github.event_name == 'release' && github.event.action == 'published'
146146
with:
147-
files: "${{ env.GHA_SIGSTORE_PYTHON_SIGNING_ARTIFACTS }}"
147+
files: "${{ env.GHA_SIGSTORE_PYTHON_INTERNAL_SIGNING_ARTIFACTS }}"

0 commit comments

Comments
 (0)