AcademySoftwareFoundation / AcademySoftwareFoundation/MaterialX
Consider running Step Security on your repo
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 2.3k
- Forks
- 464
- Avg merge
- 4d 21h
- Merged PRs (30d)
- 11
Description
StepSecurity automatically generates a pull request that adds several hardening measures to your repo. Run it here.
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:
- 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.
- Set workflow permissions to read at the top level, and enable write permissions only on the steps that require it.
- Pin workflow releases to explicit SHA values rather than named releases.
- 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running the repository through the StepSecurity Secure Repo link and inspect the generated pull request. Done means the hardening changes are split into separate pull requests for Dependabot registration, workflow permissions, SHA pinning, and applicable Harden Runner steps, excluding workflows that use the current 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