Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update PR template test instructions to use copier #437

Merged
merged 3 commits into from
Aug 19, 2024
+6 −3
Merged

Update PR template test instructions to use copier #437

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7db00f
switch PR template instructions to copier
sjvrijn Aug 19, 2024
41177d8
restore mktemp instruction; add explanatory comments
sjvrijn Aug 19, 2024
98074b7
Update .github/PULL_REQUEST_TEMPLATE.md
sjvrijn Aug 19, 2024
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
9 changes: 6 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,18 @@
<!-- remove what doesn't apply or add more if needed -->
Create a `python-template-test` repo on GitHub (will be overwritten if existing)
```
# Create a temporary directory by running the following command. Keep the XXXXXX in the directory name.
cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
cookiecutter -c <pr-branch> https://github.com/<pr-user>/python-template
# Use --vcs-ref <pr-branch> to point to the branch to you want to test
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Use --vcs-ref <pr-branch> to point to the branch to you want to test
# Use --vcs-ref <pr-branch> to point to the branch you want to test

copier copy --vcs-ref <pr-branch> https://github.com/<pr-user>/python-template .
# Fill with python-template-test info
cd python-template-test
# Create a local git repo to push to GitHub to trigger CI actions
git init
git add --all
git commit -m "First commit"
git remote add origin https://github.com/<you>/python-template-test
git remote add origin git@github.com:<you>/python-template-test.git
git push -u origin main -f
# Create a local environment to test your generated package locally
python -m venv env
source env/bin/activate
python -m pip install --upgrade pip setuptools
Expand Down