Releases: JuliaBesties/BestieTemplate.jl
Releases · JuliaBesties/BestieTemplate.jl
v0.14.1
v0.14.0
BestieTemplate v0.14.0
Merged pull requests:
- Add ExplicitImports pre-commit hook (#472) (@abelsiqueira)
- Fix Windows failures by fixing shell to bash in workflow (#493) (@abelsiqueira)
- Bump lycheeverse/lychee-action from 1 to 2 (#495) (@dependabot[bot])
- fix typo in developer guide (#497) (@lucaferranti)
- ignore
@cite
in link checks (#501) (@lucaferranti) - Implement a new strategy "Recommended and ask extras" (#502) (@abelsiqueira)
- Add protect main branch to repo setup (#507) (@clizbe)
- docs: add clizbe as a contributor for code (#509) (@allcontributors[bot])
- Fix ExplicitImports Lint action (#510) (@abelsiqueira)
Closed issues:
v0.13.0
BestieTemplate v0.13.0
BREAKING NOTICE (MANUAL INTERVENTION REQUIRED):
- The LTS version has changed from 1.6 to 1.10. When updating, if you want to change the value of
JuliaMinVersion
(the minimum version in Project.toml), then:- You must change the
.copier-answers.yml
file (before or after runningupdate
) - You must manually change
Project.toml
- You might have to manually change
Test.yml
and/orTestOnPRs.yml
in the folder.github/workflows
- You must change the
Changed
- Change internal LTS version to 1.10. This affects the default value of
JuliaMinVersion
(#486)
Fixed
- Many trailing white spaces and duplicate empty lines resulting from Jinja variables. Pre-commit succeeds more often for newly generated files with default answers (#445)
Merged pull requests:
- [AUTO] pre-commit update (#477) (@github-actions[bot])
- docs: add clizbe as a contributor for ideas (#482) (@allcontributors[bot])
- docs: add datejada as a contributor for ideas (#483) (@allcontributors[bot])
- Make UUID lowercase in the .copier-answers.yml (#487) (@abelsiqueira)
- Fix Jinja whitespaces and make pre-commit pass for recommended (#489) (@abelsiqueira)
- Update LTS to 1.10 (#492) (@abelsiqueira)
Closed issues:
v0.12.0
BestieTemplate v0.12.0
Merged pull requests:
- Fix test on tags (#478) (@abelsiqueira)
- Split Indentation in 3 questions (#479) (@abelsiqueira)
- Release v0.12.0 (#480) (@abelsiqueira)
Closed issues:
- Split indentation into JuliaIndentation, MarkdownIndentation, ConfigIndentation (#460)
v0.11.0
BestieTemplate v0.11.0
Merged pull requests:
- Don't run update tests on releases (#455) (@abelsiqueira)
- Add docs on installing pre-commit in an env (#456) (@abelsiqueira)
- Add badge.json and test on README (#457) (@abelsiqueira)
- Update badge.json (#458) (@abelsiqueira)
- Add Bestie badge to template (#459) (@abelsiqueira)
- Slight update to the docs application and update (#461) (@abelsiqueira)
- Add Python version to workflows in package and template (#462) (@abelsiqueira)
- Add first command in Next Steps: exit() to exit Julia REPL (#464) (@luisaforozco)
- [AUTO] pre-commit update (#466) (@github-actions[bot])
- Add name to the steps of documentation CI (#468) (@luisaforozco)
- Declare generate, apply and update as public (#474) (@abelsiqueira)
- Transfer package to JuliaBesties (#475) (@abelsiqueira)
Closed issues:
- Add a warning/info to the docs to help with typos (#158)
- Add docs on installing pre-commit in an env (#270)
- Create a badge to show support (#296)
- Review docs with respect to existing package users (#302)
- Tell the user that overwriting when applying to existing is preferred (#306)
- Move to organization (#318)
- Specify python-version in the workflows (#448)
- Next steps list: add exit() - exit Julia-repl (#463)
- Mark Public API with the public keyword (#473)
v0.10.1
BestieTemplate v0.10.1
Fixed
v0.10.0
BestieTemplate v0.10.0
Breaking notice:
AuthorName and AuthorEmail have been deprecated. Expect them to be removed in the next version. They are replaced by a single question Authors, which receives a comma separated list. Additionally, the Code of Conduct used the AuthorEmail, and now it has its own question.
Added
- The keyword argument quiet is now used to define verbosity (#379)
- The keyword guess in apply 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 all test-*.jl files in runtests.jl (#261)
- New question: CodeOfConductContact, the contact person/entity for the CODE_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)
Changed
- 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
Deprecated
- AuthorName and AuthorEmail have been deprecated in favour of Authors.
Merged pull requests:
- Guess on apply for pkg already using copier (#384) (@abelsiqueira)
- Refactor the code to leave the main file cleaner (#385) (@abelsiqueira)
- Create fake data and use it on the tests (#386) (@abelsiqueira)
- [AUTO] pre-commit update (#387) (@github-actions[bot])
- Implement debugging tools to help developers (#391) (@abelsiqueira)
- Use keyword argument quiet to define verbosity of wrapper (#392) (@abelsiqueira)
- Refactor test files (#393) (@abelsiqueira)
- Rename test/aux.jl to test/utils.jl because of Windows (#396) (@abelsiqueira)
- Change the TestGeneratedPkg docs test to resemble actual use (#397) (@abelsiqueira)
- Small update in the README (#398) (@abelsiqueira)
- Test pre-commit in the generated package (#399) (@abelsiqueira)
- Apply BestieTemplate 0.9.1 (#401) (@abelsiqueira)
- Remove type piracy of Base.copy (#404) (@oxinabox)
- docs: add oxinabox as a contributor for code, bug, and ideas (#406) (@allcontributors[bot])
- Change the default indentation from 2 to 4 (#407) (@abelsiqueira)
- Guess more when applying the package (#410) (@abelsiqueira)
- [AUTO] pre-commit update (#411) (@github-actions[bot])
- New question: JuliaMinCIVersion (#414) (@abelsiqueira)
- Refactor the questions into folders (#417) (@abelsiqueira)
- Fix typo (#418) (@abelsiqueira)
- Add GKSwstype in the docs workflow to prevent GR warnings (#419) (@abelsiqueira)
- New question: AutoIncludeTests (#420) (@abelsiqueira)
- Make lychee configuration to a hidden file .lychee.toml (#421) (@abelsiqueira)
- Add quickstart example usage to module docstring (#423) (@lucaferranti)
- New question: CodeOfConductContact (#429) (@abelsiqueira)
- New question: LicenseCopyrightHolders (#430) (@abelsiqueira)
- Document deprecation and add test for smooth update (#431) (@abelsiqueira)
- Support multiple authors (#432) (@abelsiqueira)
- Use a variable to improve readibility of docs/make.jl (#433) (@abelsiqueira)
- Don't create main branch when on main and don't run some tests on main (#436) (@abelsiqueira)
- Properly check for the main branch (#437) (@abelsiqueira)
- Update gitignore (#438) (@abelsiqueira)
- List questions in the documentation (#441) (@abelsiqueira)
- Bump peter-evans/create-pull-request from 6 to 7 (#442) (@dependabot[bot])
- Use min for julia-setup (#443) (@abelsiqueira)
Closed issues:
- Allow fine-tuned default selection (#80)
- Apply template to packages and gather feedback (#106)
- Review and update .gitignore (#108)
- Support multiple authors (#118)
- Add GKSwstype env to docs (#132)
- Clean up comments in TagBot.yml (#133)
- Better test structure (#261)
- Find early adopters (#267)
- List the question in the documentation (#274)
- Shell commands after creating package could be all copy pastable (#309)
- Update dev docs with local testing using Julia (#316)
- Change Test Generated Pkg to activate the docs folder and dev into the pkg (#333)
- Refactor test/runtests.jl (#340)
- Improve pages section in the docs/make.jl (#351)
- make email optional (#356)
- Improve developer experience (#374)
- Add fake answers to be reused (#375)
- Create function that uses the development version of the Bestie for the URL (use
pkgdir
?) (#376) - Use the quiet flag to suppress Bestie output as well (#379)
- [Bug] apply with existing .copier-answers.yml interaction (#383)
- Consider making lychee.toml a hidden file (#388)
- [Bug] Lots of errors with fresh application in pre-commit (#390)
- Change 1.6 to lts in the CI (#400)
- [Bug] Default indentation level should be 4 spaces (#403)
- Change CI settings to only require approval for first-time contributors who are new to GitHub (#405)
- Increase options for answers and refactor (#412)
- Mention "min" in JuliaMinCIVersion (#415)
- Refactor copier.yml into more files (#416)
- Authors revamp (#425)
- Add a
CodeOfConductContact
question to decouple it from theAuthorEmail
(#426) - Add a
LicenseHolders
question to decouple it from theAuthorName
(#427) - Document deprecation of a question. (#428)
- [Bug] Tests are broken on main due to git command in workflow (#435)
v0.9.1
BestieTemplate v0.9.1
Merged pull requests:
- docs: add gdalle as a contributor for ideas (#363) (@allcontributors[bot])
- [AUTO] pre-commit update (#372) (@github-actions[bot])
- Validate PackageName (#377) (@abelsiqueira)
- docs: add jhidding as a contributor for bug (#378) (@allcontributors[bot])
- docs: add jhidding as a contributor for review (#381) (@allcontributors[bot])
- Release 0.9.1 (#382) (@abelsiqueira)
Closed issues:
- Separate questions for Issue and PR templates (#307)
- Create an overview of differences/similarities in use case and features/plugins for each pkg (#354)
- Less opinionated and simpler minimal config (#355)
- Update Bestie version in the post-application message (#364)
- Consider adding a CODEOWNERS file to the package (#369)
- [Bug] second
.jl
is added when package name is entered with.jl
attached (#373)
v0.9.0
BestieTemplate v0.9.0
Merged pull requests:
- Clean up docs (#359) (@abelsiqueira)
- Change the templates' JuliaFormatter config to be simpler (#360) (@abelsiqueira)
- Release 0.9.0 (#361) (@abelsiqueira)
Closed issues:
v0.8.0
BestieTemplate v0.8.0
Added
- New question: AddContributionDocs to decide whether to add 90-contributing.md and 91-developer.md (#313)
Changed
- (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)
Removed
- (breaking change) Question SimplifiedPRTest was removed and the behaviour now is as if it were selected as true (#312)
Merged pull requests:
- Make GitHub PR template part of the minimum options (#337) (@abelsiqueira)
- Make TestOnPRs part of minimal template (#338) (@abelsiqueira)
- Move contributing and developer docs to recommended (#339) (@abelsiqueira)
- Create apply function and change generate (#341) (@abelsiqueira)
- Add install information on README and docs/src/index (#342) (@abelsiqueira)
- Move the pre-commit installation a bit earlier in the docs (#343) (@abelsiqueira)
- Add a preamble to the question with the link to the docs (#344) (@abelsiqueira)
- Add section explaining recommended vs minimum (#345) (@abelsiqueira)
- CompatHelper: add new compat entry for YAML at version 0.4, (keep existing compat) (#346) (@github-actions[bot])
- Release 0.8.0 (#347) (@abelsiqueira)
Closed issues:
- Add a preamble to the questions (#154)
- Install BestieTemplate.jl in usage instructions (#297)
- Function generate is not clear for application to existing packages (#301)
- Consider moving pre-commit installation earlier in the docs (#303)
- Better post-application message (#304)
- Move PULL_REQUEST_TEMPLATE.md to minimal options (#308)
- Make TestOnPRs part of minimal (#312)
- Move contributing and developer to recommended (#313)
- Explain the rationale of minimal vs recommended (#314)