From 16becb6f1dc45ba066d6af1c50db58d755ee1df6 Mon Sep 17 00:00:00 2001 From: Matthew Alexander LaChance Date: Thu, 22 Aug 2024 16:58:20 -0400 Subject: [PATCH] Add instructions for creating repos from this template --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 8a42454..3bd57af 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # forge_module_name +To get started: + +1. Run `git grep forge_module_name` and sub in the new module name. +2. Settings > Code security and analysis > Dependabot security updates > Enable +3. You'll need to set the `FORGE_API_KEY` secret to a token generated on the forge website. +4. Tests and linting will run on pushes to production and pull requests. +5. To release, update version in `metadata.json`, update `CHANGELOG.md` + with a link to the future tag and current date in the heading, push to + `production`, and Actions > Release to Puppet Forge > Run workflow. + It'll generate GitHub release notes from the changelog and update + the forge. + Welcome to your new module. A short overview of the generated parts can be found in the [PDK documentation][1].