Skip to content

Commit 4f567fc

Browse files
author
Daniel Carabas
committed
Update README information for auto release workflow
1 parent 531250b commit 4f567fc

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,16 @@ If you are using Gitpod you will need to opt-in and enable gitpod support for pd
110110

111111
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!
112112

113+
### .github/workflows/auto_release.yml
114+
115+
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.
116+
To set up the automated release cron you can add a configuration to your .sync.yml file that matches the following example:
117+
```yaml
118+
release_schedule:
119+
cron: '0 3 * * 6'
120+
```
121+
In this example the automated release prep workflow is triggered every Saturday at 3 am.
122+
113123
### .pdkignore
114124

115125
>A .pdkignore file in your repo allows you to specify files to ignore when building a module package with `pdk build`.

0 commit comments

Comments
 (0)