diff --git a/README.md b/README.md index ffa7ee96b0d4e051320a85e792db20aef0bc57ec..87aae722c5216a30313b6bb247f42dff35c6f8a6 100644 --- a/README.md +++ b/README.md @@ -51,9 +51,9 @@ The following is a description and explanation of each of the keys within config 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 +### .github/workflows/release_prep.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. +The auto release workflows prepares 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: diff --git a/config_defaults.yml b/config_defaults.yml index 5f66fd70c064cf86c045d3e7bf8157324c906d99..5d3eb87bbeab007e8b0481b82a91f7567dbd98ca 100644 --- a/config_defaults.yml +++ b/config_defaults.yml @@ -558,11 +558,11 @@ spec/spec_helper.rb: mock_with: ":rspec" strict_level: ":warning" strict_variables: true -.github/workflows/auto_release.yml: - unmanaged: true .github/workflows/ci.yml: unmanaged: true .github/workflows/nightly.yml: unmanaged: true .github/workflows/release.yml: unmanaged: true +.github/workflows/release_prep.yml: + unmanaged: true diff --git a/moduleroot/.github/workflows/auto_release.yml.erb b/moduleroot/.github/workflows/release_prep.yml.erb similarity index 57% rename from moduleroot/.github/workflows/auto_release.yml.erb rename to moduleroot/.github/workflows/release_prep.yml.erb index ea88b5d8af121a2582de6d2e3255979bc50d7d5c..534826d496be109de277952b449ad786953b652f 100644 --- a/moduleroot/.github/workflows/auto_release.yml.erb +++ b/moduleroot/.github/workflows/release_prep.yml.erb @@ -1,5 +1,5 @@ <% common = config_for('common') -%> -name: "Auto release" +name: "Release Prep" on: <% if common['release_schedule'] -%> @@ -7,8 +7,14 @@ on: - cron: <%= common['release_schedule']['cron'] %> <% end -%> workflow_dispatch: + inputs: + version: + description: "Module version to be released. Must be a valid semver string. (1.2.3)" + required: true jobs: release_prep: uses: "puppetlabs/cat-github-actions/.github/workflows/module_release_prep.yml@main" + with: + version: "${{ github.event.inputs.version }}" secrets: "inherit"