Skip to content

Commit

Permalink
chore(docs): contributing recipes
Browse files Browse the repository at this point in the history
  • Loading branch information
jbeveland27 committed Nov 30, 2020
1 parent e802a53 commit f6c75c1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,13 @@ A collection of recipies designed to support the automated installation and setu
## Getting Started

* [Recipe Spec](./recipe-spec/recipe-spec.md)
* [Testing Framework](./test-framework/README.md)
* [Testing Framework](./test-framework/README.md)

## Contributing Recipes

Recipes are written in YAML and must adhere to our [recipe spec](./recipe-spec/recipe-spec.md). The basic development workflow is:

* Create the recipe under `recipes/org/<on_host_integration_name>/<installTargetOS>.yml`
* Create a corresponding [test definition file](https://github.com/newrelic/demo-deployer/tree/main/documentation/deploy_config) under `test/definitions/ohi/linux/<installTargetOS>.yml`, as well as any needed ansible plays under `test/deploy`.
* Run the [Deployer locally](test-framework/deployer.md).
* Open a Pull Request with the new recipe and corresponding test definition files
1 change: 1 addition & 0 deletions docs/test-framework/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Recipes can be tested locally by either using the Deployer, or Terraform (DEPREC

The [validation](../.github/workflows/validation.yaml) workflow will on every Pull Request. This workflow will:

* Run schema validation using our [JSON schema validator](../../validator/README.md)
* Analyze the commits to check for any changes in the `/recipes` directory
* From that list of recipes, determine which test definition files (under `/test/definitions`) contain references to those recipes
* Run _each_ of those test definition files with the Deployer as a separate GitHub Actions job (Note: this provisions and destroys instances on EC2)
Expand Down

0 comments on commit f6c75c1

Please sign in to comment.