https://github.com/shoprunner/action-oss
Open Source Software scanning Github Action. Used to scan the tools that we Open Source for compliance with our OSS policies.
https://github.com/shoprunner/action-oss
Last synced: about 1 year ago
JSON representation
Open Source Software scanning Github Action. Used to scan the tools that we Open Source for compliance with our OSS policies.
- Host: GitHub
- URL: https://github.com/shoprunner/action-oss
- Owner: ShopRunner
- License: bsd-3-clause
- Created: 2021-03-04T21:42:54.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T23:57:06.000Z (almost 3 years ago)
- Last Synced: 2025-02-20T21:16:05.315Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 664 KB
- Stars: 1
- Watchers: 28
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# action-oss
[](https://github.com/ShopRunner/action-oss/actions/workflows/ci.yaml)
Open Source Software scanning Github Action. Used to scan the tools that we Open Source for compliance with ShopRunner OSS policies.
## Usage
You can add the action to a workflow below.
```yaml
name: "Compliance"
on:
pull_request:
branches:
- main
push:
branches:
- main
jobs:
scan:
name: Scan
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v1
- name: OSS Scan
uses: shoprunner/action-oss@main
```
## General Requirements
Below are the requirements that will be enforced. This list is not all-inclusive but should be the primary
requirements.
### Correct Documentation
- `CODE-OF-CONDUCT.md` in root directory, using the preset [template](/dist/templates/docs/CODE-OF-CONDUCT.md)
- `CONTRIBUTING.md` in the root directory (no linting of contents)
- `bug_report.md` in the `.github/ISSUE_TEMPLATE` directory (no linting of contents)
- `feature_request.md` in the `.github/ISSUE_TEMPLATE` directory (no linting of contents)
### Approved License
- [BSD-3-Clause](/dist/templates/licenses/BSD-3-Clause)
- [MIT](/dist/templates/licenses/MIT)
## Gotchas
- **`CODE-OF-CONDUCT.md` Sensitivity** - The linter is very sensitive, please copy the file verbatim (i.e. don't add whitespace or new lines)
- **Case Sensitivity** - Any file being linted MUST be spelled correctly, including the case (i.e. `PULL_REQUEST_TEMPLATE.md` vs `pull_request_template.md`) or it will error.
- **`LICENSE` file extension** - You MUST NOT add a `.txt` or other file extension to the `LICENSE` file.
## Attribution
The vast majority of this repository is based on: [https://github.com/auth0/open-source-template](https://github.com/auth0/open-source-template).