diff --git a/README.md b/README.md index ad75ee11405e1de8ab1b8dd48f435b27b8ea4208..d49f076c187dbc23d019cf205cfac8475dfb66ec 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,16 @@ If you are using Gitpod you will need to opt-in and enable gitpod support for pd These workflows are depending on puppet-internal resources and are currently not suited for public consumption. Feel free to take them as inspiration how to run some tests on Github Actions. Please let us know at <ia_content@puppet.com> what you come up with! +### .github/workflows/auto_release.yml + +The auto release workflows uses the PDK experimental command `pdk release prep` to prepare a module release PR. By default the workflow can be triggered manually when a release preparation PR needs to be created, however it allows setting a cron based trigger that can run automatically. +To set up the automated release cron you can add a configuration to your .sync.yml file that matches the following example: +```yaml +release_schedule: + cron: '0 3 * * 6' +``` +In this example the automated release prep workflow is triggered every Saturday at 3 am. + ### .pdkignore >A .pdkignore file in your repo allows you to specify files to ignore when building a module package with `pdk build`. diff --git a/moduleroot/.github/workflows/auto_release.yml.erb b/moduleroot/.github/workflows/auto_release.yml.erb index 8776dec7b933d7d396f208c3f9d3ce8e0fc16357..eb8850f1833b17fba35f36efee1e99dbaf84fae0 100644 --- a/moduleroot/.github/workflows/auto_release.yml.erb +++ b/moduleroot/.github/workflows/auto_release.yml.erb @@ -2,8 +2,10 @@ name: "Auto release" on: +<% if common['release_schedule'] -%> schedule: - - cron: '0 3 * * 6' + - cron: <%= common['release_schedule']['cron'] %> +<% end -%> workflow_dispatch: env: