Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unclear how to list features of non-default template #138

Open
bbannier opened this issue Sep 27, 2022 · 1 comment
Open

Unclear how to list features of non-default template #138

bbannier opened this issue Sep 27, 2022 · 1 comment

Comments

@bbannier
Copy link
Contributor

One can currently override the template used during zkg create with --template <DIR>. In order to discover features of a template create's documentation suggest using template info

--features FEATURE [FEATURE ...]
     Additional features to include in your package. Use the ``template info`` command for information about available features. (default: None)

It looks like template info does not support a flag like --template to switch the template to use; this makes it hard to discover features of non-default templates.

@ckreibich
Copy link
Member

It's there Benjamin, you can provide it as the last argument to zkg template info:

$ zkg template info https://github.com/bbannier/package-template
API version: 1.0.0
features: github-ci, license, plugin
origin: https://github.com/bbannier/package-template
provides package: true
user vars:
        name: the name of the package, e.g. "FooBar", no default, used by package
        namespace: a namespace for the package, e.g. "MyOrg", no default, used by plugin
        author: your name and email address, Christian Kreibich <christian@corelight.com>, used by license
        license: one of apache, bsd-2, bsd-3, mit, mpl-2, no default, used by license
versions: v0.99.0

I remember that originally I wanted to do the same thing with zkg create, but I hit argument ambiguity and so ended up with --template. I think those concerns might now be gone, and it'd be nice if both commands worked the same way. I'll take a look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants