Skip to content

Commit 2a846a2

Browse files
Replace short-form URLS
Replace short-form URLS with long-form URLS in documentation. Copier supports URLs of the style gh:org/repo, but other supporting tools, such as renovate, may not. We have chosen to use the well-known standard.
1 parent 002a1c5 commit 2a846a2

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

.github/workflows/_example.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
2121
- name: Rewrite copier answers
2222
run: |
23-
sed -i 's|_src_path: .|_src_path: gh:DiamondLightSource/python-copier-template|' example/.copier-answers.yml
23+
sed -i 's|_src_path: .|_src_path: https://github.com/DiamondLightSource/python-copier-template.git|' example/.copier-answers.yml
2424
2525
- name: Publish example
2626
# We pin to the SHA, not the tag, for security reasons.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You will need to `pip install copier` inside an activated `venv` from python3.10
4848
```
4949
mkdir /path/to/my-project
5050
# The --trust argument is required to run setup tasks such as initializing a git repository
51-
copier copy --trust gh:DiamondLightSource/python-copier-template /path/to/my-project
51+
copier copy --trust https://github.com/DiamondLightSource/python-copier-template.git /path/to/my-project
5252
```
5353

5454
You can also use it via `pipx run copier` if you have that installed.

docs/tutorials/adopt-existing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Copier will *overwrite* files with the template files. Please check the changes
1818
If you have a [python3-pip-skeleton](https://github.com/DiamondLightSource/python3-pip-skeleton) based project then it is best to adopt the `1.0.0` release of this template, then `copier update` to get to the latest. This is because `copier update` will try and merge file changes across renames done between releases, while `copier copy` cannot. This looks like:
1919

2020
```shell
21-
copier copy gh:DiamondLightSource/python-copier-template --trust --vcs-ref=1.0.0 /path/to/existing-project
21+
copier copy https://github.com/DiamondLightSource/python-copier-template.git --trust --vcs-ref=1.0.0 /path/to/existing-project
2222
git diff
2323
# Examine the changes, put back anything you want to keep
2424
git commit -m "Adopt python-copier-template 1.0.0"
@@ -33,7 +33,7 @@ git commit -m "Update to python-copier-template x.x.x"
3333
If you have a project with a different structure then it is best to go straight to the latest release:
3434

3535
```shell
36-
copier copy --trust gh:DiamondLightSource/python-copier-template /path/to/existing-project
36+
copier copy --trust https://github.com/DiamondLightSource/python-copier-template.git /path/to/existing-project
3737
git diff
3838
# Examine the changes, put back anything you want to keep
3939
git commit -m "Adopt python-copier-template x.x.x"

docs/tutorials/create-new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Once you have followed the [](./installation) tutorial, you can use `copier` to
44

55
```
66
$ mkdir /path/to/my-project
7-
$ copier copy --trust gh:DiamondLightSource/python-copier-template /path/to/my-project
7+
$ copier copy --trust https://github.com/DiamondLightSource/python-copier-template.git /path/to/my-project
88
```
99

1010
This will:

0 commit comments

Comments
 (0)