Skip to content

Commit 15fba94

Browse files
authored
command: add profiles descriptions and update URL (#1156)
1 parent 10449f2 commit 15fba94

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

charmcraft/commands/init.py

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,29 @@
4545
4646
This command will modify the directory to create the necessary files for a
4747
charm operator package. By default it will work in the current directory.
48-
It will setup the following tree of files and directories:
48+
49+
Available profiles are:
50+
simple:
51+
A basic kubernetes charm with lot of texts helping the developer
52+
to navigate their first charm by following the instructions.
53+
kubernetes:
54+
A basic Kubernetes charm with exmaple container.
55+
machine:
56+
A basic charm but meant to be deployed in machine-based environments,
57+
without container requirements.
58+
59+
Depending on the profile choice, Charmcraft will setup the following tree of
60+
files and directories:
4961
5062
.
5163
├── charmcraft.yaml - Charm build configuration
5264
├── config.yaml - Config schema for your operator
53-
├── CONTRIBUTING.md - Instructions for how to build and develop your charm
65+
├── CONTRIBUTING.md - Instructions for how to build and develop
66+
│ your charm
5467
├── LICENSE - Your charm license, we recommend Apache 2
5568
├── metadata.yaml - Charm operator package description
56-
├── pyproject.toml - Configuration for testing, formatting and linting tools
69+
├── pyproject.toml - Configuration for testing, formatting and
70+
│ linting tools
5771
├── README.md - Frontpage for your charmhub.io/charm/
5872
├── requirements.txt - PyPI dependencies for your charm, with `ops`
5973
├── src
@@ -117,8 +131,7 @@ def fill_parser(self, parser):
117131
"--profile",
118132
choices=list(PROFILES),
119133
default=DEFAULT_PROFILE,
120-
help=f"""Use the specified project profile (defaults to '{DEFAULT_PROFILE}', """
121-
f"""could be one of {', '.join(f"'{p}'" for p in PROFILES)})""",
134+
help=f"Use the specified project profile (defaults to '{DEFAULT_PROFILE}')",
122135
)
123136

124137
def run(self, args):

charmcraft/templates/init-simple/src/charm.py.j2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
"""Charm the service.
88
9-
Refer to the following post for a quick-start guide that will help you
9+
Refer to the following tutorial that will help you
1010
develop a new k8s charm using the Operator Framework:
1111
12-
https://discourse.charmhub.io/t/4208
12+
https://juju.is/docs/sdk/create-a-minimal-kubernetes-charm
1313
"""
1414

1515
import logging

0 commit comments

Comments
 (0)