Skip to content

Commit 647e2a4

Browse files
committed
Update README
1 parent 802cd0d commit 647e2a4

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,18 @@ The only situation where you would specify a value for `registry` is when you wa
2323
4. Open a pull request against the registry that tags the first new commit on the release branch as a new version `x.y.z`
2424
5. Open a pull request against the package repository to merge the release branch into `master`
2525

26-
### PkgDev.enable_pkgbutler(package_name; channel=:auto)
26+
### PkgDev.enable_pkgbutler(package_name; channel=:auto, template=:auto)
2727

2828
Enables the Julia Package Butler for package `package_name`. The package must be deved in the current Julia environment. The command will make various modifications to the files in the deved folder of the package. You then then need to commit these changes and push them to GitHub. The command will also add a deploy key to the GitHub repository of the package and show instructions on how to add two GitHub Actions secrets to the repository.
2929

3030
The `channel` argument can be `:auto`, `:stable` or `:dev`. There are two channels of updates: `stable` and `dev`. The `dev` channel will run the Julia Package Butler workflow every 5 minutes and it will use the `master` branch of the [Julia Packge Butler engine](https://github.com/davidanthoff/PkgButlerEngine.jl), i.e. it will get new features more quickly. The `stable` branch runs the Julia Package Butler workflow every hour, and new features in the Julia Package Butler engine are only pushed out to the stable channel once they have been tested for a while on the `dev` channel. If you specify `:auto` as the argument, any existing channel choice you have previously made for the package will be retained, otherwise the package will be configure for the `stable` channel.
3131

32+
The `template` argument can be `:auto`, `:default` or `:bach`. Different templates will configure different aspects of your package. At this point everyone should use the `:default` template (or `:auto` template), everything else is considered experimental.
33+
3234
### PkgDev.switch_pkgbutler_channel(package_name, channel)
3335

3436
Switch the Julia Package Butler channel for package `package_name`. The package you want to tag must be deved in the current Julia environment and the Julia Package Butler must already be enabled for the package. The `channel` argument can be `:auto`, `:stable` or `:dev`, see the documentation for `PkgDev.enable_pkgbutler` for an explanation of the different channels.
37+
38+
### PkgDev.switch_pkgbutler_template(package_name, template)
39+
40+
Switch the Julia Package Butler template for package `package_name`. The package you want to tag must be deved in the current Julia environment and the Julia Package Butler must already be enabled for the package. The `template` argument can be `:auto`, `:default` or `:bach`.

0 commit comments

Comments
 (0)