From 9c0f86aff3b55de8a9a30076b12b9b6df90ec5c6 Mon Sep 17 00:00:00 2001 From: Bernie White Date: Sat, 21 Dec 2024 17:14:49 +1000 Subject: [PATCH] Add sample path #2614 (#2680) --- .github/ISSUE_TEMPLATE/sample_proposal.yaml | 2 +- docs/CHANGELOG-v3.md | 6 ++++ samples/README.md | 34 +++++++++++++++++++++ samples/azure/README.md | 5 +++ 4 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 samples/README.md create mode 100644 samples/azure/README.md diff --git a/.github/ISSUE_TEMPLATE/sample_proposal.yaml b/.github/ISSUE_TEMPLATE/sample_proposal.yaml index 965ef4289c..a704e29013 100644 --- a/.github/ISSUE_TEMPLATE/sample_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/sample_proposal.yaml @@ -31,7 +31,7 @@ body: attributes: label: Sample path description: The path to the new sample. - placeholder: samples/rules/name + placeholder: samples/name validations: required: true - type: textarea diff --git a/docs/CHANGELOG-v3.md b/docs/CHANGELOG-v3.md index dcff372227..8127c0816d 100644 --- a/docs/CHANGELOG-v3.md +++ b/docs/CHANGELOG-v3.md @@ -27,6 +27,12 @@ See [upgrade notes][1] for helpful information when upgrading from previous vers ## Unreleased +What's changed since pre-release v3.0.0-B0351: + +- Engineering: + - Migrate samples into PSRule repository by @BernieWhite. + [#2614](https://github.com/microsoft/PSRule/issues/2614) + ## v3.0.0-B0351 (pre-release) What's changed since pre-release v3.0.0-B0342: diff --git a/samples/README.md b/samples/README.md new file mode 100644 index 0000000000..8b4c2cdd9c --- /dev/null +++ b/samples/README.md @@ -0,0 +1,34 @@ +# Samples + +You have reached samples for PSRule. +If you have a question about these samples, please start a discussion on GitHub. + +For samples that related to Azure see [PSRule for Azure - samples][1]. + + [1]: https://github.com/Azure/PSRule.Rules.Azure/tree/main/samples/rules + +## Contributing samples + +Additional samples can be contributed. +Please use the following structure for your `README.md`. +Replace the comment placeholders with details about your sample. + +```markdown +# + + + +## Summary + + + +## Usage + + + +## References + + + +- [Conventions](https://microsoft.github.io/PSRule/v3/concepts/PSRule/en-US/about_PSRule_Conventions/#including-with-options) +``` diff --git a/samples/azure/README.md b/samples/azure/README.md new file mode 100644 index 0000000000..eb14091bee --- /dev/null +++ b/samples/azure/README.md @@ -0,0 +1,5 @@ +# PSRule samples for Azure + +To find samples that related to Azure at [PSRule for Azure - samples][1] as a single central location. + + [1]: https://github.com/Azure/PSRule.Rules.Azure/tree/main/samples/rules