Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 1.86 KB

README.md

File metadata and controls

55 lines (41 loc) · 1.86 KB
Raw

action-oss

CI

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.

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
  • 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

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.