Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.23 KB

tooling.md

File metadata and controls

37 lines (22 loc) · 1.23 KB
Raw

Embark OSS tooling

This program is used to validate that our open source projects adhere to our open source guidelines.

Periodic jobs

Project validation

Every weekday the validate-all command is run on GitHub actions, sending us a Slack notification if any problems are found.

Commands

cargo run validate-all

This command checks to see if every project listed in the Embark opensource-website data.json and every public repository in the EmbarkStudios GitHub organisation conforms to our open source guidelines to the extent that this tool can detect.

Flags

  • --slack-webhook-url: An optional Slack webhook URL that is used to report problems.
  • --github-api-token: An optional API token used to raise the rate limit of the GitHub API. Likely only needed on CI where we share an IP with other GitHub API users.

cargo run validate PROJECT_REPO_NAME

This command checks to see if a given Embark open source project conforms to our open source guidelines to the extent that this tool can detect.

Testing

This tool has unit tests. Run them like so:

cargo test