Skip to content

Commit 4f83858

Browse files
committed
Apply comments per review via IDE to make clearer why certain actions are taken
1 parent 4c5fcb1 commit 4f83858

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

doc/user_guide/getting_started.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ Use the following command to create a new project:
3939
cookiecutter https://github.com/exasol/python-toolbox.git \
4040
--checkout <latest-tag> --directory project-template
4141
42+
.. note::
43+
44+
Without option :code:`--checkout` cookiecutter will use the main branch of the PTB. In order
45+
to get reliable and reproducible results, we recommend using the tag of PTB's latest released
46+
version instead.
47+
4248
**2. Follow the interactive project setup prompt**
4349

4450
**3. Bootstrap the development environment**

test/integration/project-template/conftest.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ def new_project(cwd):
2929
@pytest.fixture(scope="session", autouse=True)
3030
def poetry_install(run_command, poetry_path):
3131
run_command([poetry_path, "install"])
32+
# The tests want to verify the current branch of the PTB incl. its cookiecutter
33+
# template before releasing the PTB. The following command therefore modifies the
34+
# dependency to the PTB itself in the pyproject.toml file by replacing the latest
35+
# released PTB version with the current checked-out branch in PROJECT_CONFIG.root:
3236
run_command([poetry_path, "add", "--group", "dev", PROJECT_CONFIG.root])
3337

3438

0 commit comments

Comments
 (0)