Skip to content

Commit eec6b0e

Browse files
committed
Update on naming for the repo readme vs
the app readme, since these are actually different. Also make any usage of the slim packaging feature generate an exception.
1 parent 5abb8e0 commit eec6b0e

File tree

4 files changed

+15
-13
lines changed

4 files changed

+15
-13
lines changed

contentctl/actions/initialize.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ def execute(self, config: test) -> None:
3737
#Throw an exception if the target exists
3838
shutil.copytree(source_directory, target_directory, dirs_exist_ok=False)
3939

40-
#Create the config file as well
41-
shutil.copyfile(pathlib.Path(os.path.dirname(__file__))/'../templates/README','README')
40+
# Create a README.md file. Note that this is the README.md for the repository, not the
41+
# one which will actually be packaged into the app. That is located in the app_template folder.
42+
shutil.copyfile(pathlib.Path(os.path.dirname(__file__))/'../templates/README.md','README.md')
4243

4344

4445
print(f"The app '{config.app.title}' has been initialized. "

contentctl/output/conf_output.py

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -169,15 +169,8 @@ def packageAppTar(self) -> None:
169169

170170
def packageAppSlim(self) -> None:
171171

172-
173-
# input_app_path = pathlib.Path(self.config.build.path_root)/f"{self.config.build.name}"
174-
175-
# readme_file = pathlib.Path("README")
176-
# if not readme_file.is_file():
177-
# raise Exception("The README file does not exist in this directory. Cannot build app.")
178-
# shutil.copyfile(readme_file, input_app_path/readme_file.name)
179-
180-
172+
raise Exception("Packaging with splunk-packaging-toolkit not currently supported as slim only supports Python 3.7. "
173+
"Please raise an issue in the contentctl GitHub if you encounter this exception.")
181174
try:
182175
import slim
183176
from slim.utils import SlimLogger

contentctl/templates/README

Lines changed: 0 additions & 2 deletions
This file was deleted.

contentctl/templates/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Contentctl App Readme
2+
3+
This README file was automatically created by contentctl init.
4+
Please fill it with meaningful information that describes your app.
5+
6+
Note that this file can contain Markdown and will be richly rendered in GitHub or most other Version Control Systems.
7+
8+
9+
Note: This readme file is actually DIFFERENT from the one that will be packaged as part of your App.
10+
That file is located at app_template/README.md.

0 commit comments

Comments
 (0)