All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Breaking notice:
AuthorName
andAuthorEmail
have been deprecated. Expect them to be removed in the next version. They are replaced by a single questionAuthors
, which receives a comma separated list. Additionally, the Code of Conduct used theAuthorEmail
, and now it has its own question.
- The keyword argument
quiet
is now used to define verbosity (#379) - The keyword
guess
inapply
to control whether guessing answers is desired (#225) - The minimum Julia version is also guessed now (#225)
- The package owner is also guessed now (#225)
- The indentation is also guessed now (#225)
- New question:
JuliaMinCIVersion
, which defines which Julia version to use in the CI (#400) - New question:
AutoIncludeTests
, that auto-includes alltest-*.jl
files inruntests.jl
(#261) - New question:
CodeOfConductContact
, the contact person/entity for theCODE_OF_CONDUCT.md
file (#426) - New question:
LicenseCopyrightHolders
, the copyright holders listed in the LICENSE (#427) - New question:
Authors
, a comma separated list of authors. (#118)
- Update pre-commit hook versions
- JuliaFormatter 1.0.58 -> 1.0.60
- Default Indentation changed from 2 to 4 (#403)
- Change lychee configuration to a hidden file
.lychee.toml
AuthorName
andAuthorEmail
have been removed.
0.9.1 - 2024-07-24
- Update pre-commit hook versions
- JuliaFormatter 1.0.56 -> 1.0.58
- Validate package name to enforce capital first letter and letters and numbers (#373)
0.9.0 - 2024-07-13
- Default
.JuliaFormatter
now includes only minimal configuration that matches.editorconfig
(#358)
0.8.0 - 2024-07-08
- New question: AddContributionDocs to decide whether to add 90-contributing.md and 91-developer.md (#313)
- (breaking change) GitHub PR template is now part of the minimal options (#308)
- (breaking change) TestOnPRs.yml is now part of the minimal options (#312)
- (breaking change) 90-contributing.md and 91-developer.md have moved from minimal to recommended. If you use the minimal option, then these files will be removed (#313)
- (breaking change)
generate
does not work on existing folders anymore. The functionapply
was created to handle that case (#301)
- (breaking change) Question SimplifiedPRTest was removed and the behaviour now is as if it were selected as true (#312)
0.7.2 - 2024-07-07
- Add example to the generated package src and test (#299)
- Fixed typos in the template for README.md (#327)
- Simplify Cirrus CI (PR #332)
- Lint.yml was missing from minimum options (#317)
0.7.1 - 2024-07-02
- Logo has changed.
- Apply the template version 0.7.0
0.7.0 - 2024-06-26
- Rename the package from COPIERTemplate.jl to BestieTemplate.jl
0.6.1 - 2024-06-21
- Small improvements to templates
0.6.0 - 2024-06-14
- Rename files in docs/src/ 90-developer to 91 and 90-reference to 95 (#273)
0.5.4 - 2024-06-11
- Indentation is now a required question
0.5.3 - 2024-06-10
- Update documentation in various places
- Add developer documentation for dealing with the template
- Template had bad double quotes instead of single in the Test.yml workflow
0.5.2 - 2024-06-08
- Update function that calls copier's run_update (#113)
- Safeguard to avoid running generate when you want update (#247)
- Improve skip section in README.md and make small corrections in the template
0.5.1 - 2024-06-07
- New question: AddPrecommit to add pre-commit related files (#231)
- New question: AddGitHubTemplates to add issue and PR templates (#233)
- New question: AnswerStrategy to choose between using recommended, minimum, or ask every question (#235)
- New question: AddCopierCI to add Copier.yml (#237)
- Issue checklists are now just text (#234)
0.5.0 - 2024-06-06
- New question: SimplifiedPRTest to simplify the testing on Pull Requests (#105)
- New question: AddAllcontributors to add a section and config for https://allcontributors.org (#26)
copy
,recopy
andupdate
from the copier API (#142)- When applying to existing projects, read Project.toml to infer a few values (#116)
- Automatically determines the
PackageName
from the destination folder (#151)
- Adds
data
positional argument togenerate
(#142) - An internal module
Copier
was created with the wrapper functions - Use lychee for link-checker instead of markdown-link-checker (#160)
- The
generate_missing_uuid
argument was removed, since it can be generated via Jinja (#189)
0.4.0 - 2024-05-31
- Pre-commit update workflow (#91)
- Signature of generate now accepts source path, which defaults to the URL (#174)
0.3.2 - 2024-05-30
- More reader-friendly README (#144)
- Add author names to licenses (#145)
- Consistent caching in GitHub workflows (#53)
0.3.1 - 2024-05-23
- Dependabot (#52)
0.3.0 - 2024-05-17
- Indentation option (#44)
- CODE_OF_CONDUCT (#25)
- Issue and Pull Request templates (#33)
- AskAdvancedQuestions question to allow stopping early (#67)
- Update Cirrus CI image_family (#31)
- Prefix some doc files with a number and generate the pages programmatically (#32)
- Reestructure and improve the documentation (#77)
- Coverage now checks main branch (#65)
0.2.5 - 2024-02-23
- nightly key was duplicated (#49)
0.2.4 - 2023-12-21
- pipx link changed
0.2.3 - 2023-10-31
- Add
workflow_dispatch
to Test.yml
- Windows support
0.2.2 - 2023-10-02
- Don't skip contributing.md and developer.md on updates
0.2.1 - 2023-10-02
- asciinema link in the README
- Text and typos on contribuing and developer
0.2.0 - 2023-09-24
- First Julia release
0.1.9 - 2023-09-24
- Remove
_exclude
section fromcopier.yml
0.1.8 - 2023-09-24
- Should be installable as a Julia package now
- Use PythonCall to run copier directly from the Julia package
- Move template to subdirectory
- Allow failure in nightly Julia Test.yml workflow
0.1.7 - 2023-09-22
- Rename Compliance to Copier in various places (including this CHANGELOG)
0.1.6 - 2023-09-22
- Use pre-commit to prevent adding .rej files and ongoing merge conflicts
- Add configuration file for markdown link checker and ignore @ref
- Only ignore Project.toml, not all toml
- Change markdown-lint to fix version
0.1.5 - 2023-09-22
- Properly fix copier update when there are conflicts
0.1.4 - 2023-09-22
- Fix copier update when there are conflicts
0.1.3 - 2023-09-21
- Run pre-commit in the Copier workflow to commit the formatters change as well
- Add a basic structure for the copy's CITATION.cff
0.1.2 - 2023-09-16
- Zenodo DOI
- Instruction to add a Zenodo DOI
- Badge on README
- Documenter compat is 1
- Remove keywords strict and linkcheck from docs/make.jl
- File docs/make.jl should not be skipped
0.1.1 - 2023-09-15
- Add CITATION.cff
- Exclude docs/assets/logo.png
0.1.0 - 2023-09-12
- Initial release