Skip to content

Make changelog optional #480

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.

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

Merged
merged 4 commits into from
Aug 21, 2024
Merged

Make changelog optional #480

merged 4 commits into from
Aug 21, 2024

Conversation

sverhoeven
Copy link
Member

@sverhoeven sverhoeven commented Aug 21, 2024

Fixes #462

Description

Instructions to review the pull request

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)
# 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
# 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 [email protected]:<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
python -m pip install '.[dev,publishing]'

Yes changelog

🎤 Add a change log to keep track of changes in the package
   Yes

Should create CHANGELOG.md and mention it in other files.

No changelog

🎤 Add a change log to keep track of changes in the package
   No

Should not create CHANGELOG.md or any mention of it in other files.

@sverhoeven sverhoeven marked this pull request as draft August 21, 2024 09:58
@sverhoeven sverhoeven marked this pull request as ready for review August 21, 2024 10:15
@lyashevska lyashevska assigned lyashevska and unassigned lyashevska Aug 21, 2024
Copy link
Member

@lyashevska lyashevska left a comment

Choose a reason for hiding this comment

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

thanks @sverhoeven, I tested both cases and it works as expected.

@sverhoeven sverhoeven merged commit e2b6ce6 into main Aug 21, 2024
16 checks passed
@sverhoeven sverhoeven deleted the 462-optional-changelog branch August 21, 2024 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add optional question to copier questionnaire: changelog
2 participants