Skip to content

Commit 4de6747

Browse files
DOC: Advocate for using action from tagged release commit SHAs
* For security best practices, advocate that users of the action use it from known commit SHAs that correspond to tagged releases. * Advocate that users use a Dependabot config file to update the action on new tags. This will bump the commit SHA and also bump the release tag in the comment of the commit SHA. - c.f. https://learn.scientific-python.org/development/guides/gha_basic/#updating
1 parent dbd5a4d commit 4de6747

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,25 @@ jobs:
1111
steps:
1212
...
1313
- name: Upload wheel
14-
uses: scientific-python/upload-nightly-action@main
14+
uses: scientific-python/upload-nightly-action@8f0394fd2aa0c85d7364a9958652e8994e06b23c # 0.1.0
1515
with:
1616
artifacts_path: dist
1717
anaconda_nightly_upload_token: ${{secrets.UPLOAD_TOKEN}}
1818
```
1919
20+
It is [recommended that Dependabot is used][] to keep the GitHub Action updated
21+
to the latest release by using a `.github/dependabot.yml` config file similar to
22+
23+
```yaml
24+
version: 2
25+
updates:
26+
# Maintain dependencies for GitHub Actions
27+
- package-ecosystem: "github-actions"
28+
directory: "/"
29+
schedule:
30+
interval: "weekly"
31+
```
32+
2033
To request access to the repository please open an issue on [this action
2134
repository](https://github.com/scientific-python/upload-nightly-action). You can
2235
then generate a token at `https://anaconda.org/scientific-python-nightly-wheels/settings/access`
@@ -60,6 +73,6 @@ dependencies:
6073
- --pre --index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple --extra-index-url https://pypi.org/simple
6174
- matplotlib
6275
```
63-
76+
[recommended that Dependabot is used]: https://learn.scientific-python.org/development/guides/gha_basic/#updating
6477
[nightly package index]: https://anaconda.org/scientific-python-nightly-wheels
6578
[PyPI]: https://pypi.org/

0 commit comments

Comments
 (0)