Skip to content

Commit

Permalink
(CONT-930) - Update release prep template
Browse files Browse the repository at this point in the history
  • Loading branch information
jordanbreen28 committed May 15, 2023
1 parent d05508f commit c3f57b7
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]> 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:
Expand Down
4 changes: 2 additions & 2 deletions config_defaults.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
<% common = config_for('common') -%>
name: "Auto release"
name: "Release Prep"

on:
<% if common['release_schedule'] -%>
schedule:
- 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"

0 comments on commit c3f57b7

Please sign in to comment.