Releases: JuliaBesties/BestieTemplate.jl
Releases · JuliaBesties/BestieTemplate.jl
v0.16.2
BestieTemplate v0.16.2
v0.16.1
BestieTemplate v0.16.1
Merged pull requests:
- Change permissions of project when generating using :local (#533) (@abelsiqueira)
Closed issues:
- [Bug] Read-only when using the
:local
option (#532)
v0.16.0
BestieTemplate v0.16.0
Breaking notice:
- This version had a major refactor of the strategies. You will have to reevaluate which strategy to follow in an update. Here is a simple guide:
Tiny
: Only used for bare-bones package;Light
: Closest to the most common Julia experience (now the default);Moderate
: Adds best practices, but keeps it reasonable for solo devs;Robust
: Adds best practices for larger packages and communities.
Added
- New question:
AddCitationCFF
to make the CITATION.CFF optional. - New question:
AddDependabot
to make.github/dependabot.yml
optional. - New question:
AddGitHubPRTemplate
to make.github/PULL_REQUEST_TEMPLATE.md
optional. - New question:
AddLintCI
to make.github/workflows/Lint.yml
optional. - New question:
AddDocs
to make thedocs
folder optional. - New question:
AddDocsCI
to make.github/workflows/Docs.yml
optional. - New question:
AddCompatHelperCI
to make.github/workflows/CompatHelper.yml
optional. - New question:
AddTagBotCI
to make.github/workflows/TagBot.yml
optional. - New question:
AddTestCI
to make.github/workflows/
'sTest.yml
,TestOnPRs
, andReusableTest.yml
optional. - New question:
AddLychee
to make.lychee.toml
optional. - New question:
AddFormatterAndLinterConfigFiles
to include configuration files for linters and formatters. - New function:
new_pkg_quick
, for a non-interactive way to create a new package. - Functions
generate
andapply
have new methods accepting:local
and:online
.
Changed
- Reworks the strategy system to use
StrategyLevel
.- Introduces the levels Minimalistic, Light, Moderate, and Robust.
- Rename
Minimalistic
toTiny
. - Badges on the template's README.md are better separated according to the options.
Merged pull requests:
- Refactor questions to account for more levels of strategies and create smaller "minimal" version (#528) (@abelsiqueira)
Closed issues:
- More minimal "Minimal" (#516)
v0.15.0
BestieTemplate v0.15.0
Breaking changes:
- Previously deprecated questions for
AuthorName
,AuthorEmail
, andIndentation
are now removed.
Merged pull requests:
- Bump codecov/codecov-action from 4 to 5 (#517) (@dependabot[bot])
- Propagate pre-commit autoupdate workflow changes to the template (#518) (@abelsiqueira)
- fix: correct wording in api.jl documentation (#519) (@cpaniaguam)
- [AUTO] pre-commit update (#521) (@github-actions[bot])
- Remove deprecated AuthorName, AuthorEmail, and Indentation (#522) (@abelsiqueira)
- Avoid backslash in description (#524) (@tmigot)
- Remove prettier and add yamlfmt (#525) (@abelsiqueira)
Closed issues:
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)