Skip to content
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
pkgs/sage-project-cookiecutter/README.rst: Document using --overwrite…
…-if-exists
  • Loading branch information
Matthias Koeppe committed Nov 10, 2024
commit 18e3d1a8ad28f61b1507e8ee674b61dba2871853
9 changes: 6 additions & 3 deletions pkgs/sage-project-cookiecutter/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,19 @@ Adding Sage CI portability/integration testing infrastructure to an upstream pro

$ sage-project-cookiecutter create --upstream-package PROJECT-DIRECTORY

Creates:
Creates in the existing ``PROJECT-DIRECTORY``:

- ``.github/workflows/ci-sage.yml``
- ``.devcontainer/portability-*``
- ``.devcontainer/tox-docker-in-docker``

It can also be invoked as follows::

$ pipx run cruft create https://github.com/mkoeppe/sage --checkout sagemath-environment-cookiecutter \
--directory="pkgs/sage-project-cookiecutter/sage_project_cookiecutter/upstream-package-template"
[alice@localhost PROJECT-DIRECTORY]$ (cd .. && pipx run cruft create \
https://github.com/mkoeppe/sage --checkout sagemath-environment-cookiecutter \
--directory="pkgs/sage-project-cookiecutter/sage_project_cookiecutter/upstream-package-template" \
--overwrite-if-exists)
[1/1] Name of the project (directory name to create) (my-sage-project): PROJECT-DIRECTORY


Creating a pip-installable upstream package of the SageMath organization
Expand Down