AcademySoftwareFoundation / AcademySoftwareFoundation/OpenShadingLanguage
Consider running StepSecurity on your repo
- Dominant language
- C++
- Stars
- 2.3k
- Forks
- 414
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 10
Description
StepSecurity automatically generates a pull request that adds several hardening measures to your repo. Run it [here](https://app.stepsecurity.io/securerepo).
By default, the process will create one composite PR that makes multiple changes. I recommend running it several times to create separate PRs for each feature.
The changes it makes include:
1. dependabot - registers the repo with a GitHub service that subsequently submits PRs to upgrade to new releases of workflow actions. An example OpenEXR PR is [here](https://github.com/AcademySoftwareFoundation/openexr/pull/1807).
2. Set workflow permissions to read at the top level, and enable write permissions only on the steps that require it.
3. Pin workflow releases to explicit SHA values rather than named releases.
4. Adds a "Harden Runner" step that monitors CI jobs, although note that this does not work with the current release of the ASWF images, don't enable this for any workflow that uses the prebuilt images.
Contributor guide
Research direction
Run StepSecurity Secure Repo from the linked page and review the generated pull requests for this repository's workflows. Keep the hardening changes separate where possible, enable only appropriate workflow permissions, pin action releases to SHAs, and leave Harden Runner disabled for workflows using the prebuilt ASWF images.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, security
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100