Skip to content

Releases: JuliaBesties/BestieTemplate.jl

v0.14.1

12 Nov 09:27
Compare
Choose a tag to compare

BestieTemplate v0.14.1

Diff since v0.14.0

Merged pull requests:

Closed issues:

  • [Bug] Precompilation Error In Julia 1.11 (#513)

v0.14.0

29 Oct 20:57
Compare
Choose a tag to compare

BestieTemplate v0.14.0

Diff since v0.13.0

Merged pull requests:

Closed issues:

  • Check if we want ExplicitImports.jl and if it can be added as a workflow or hook (#217)
  • Find a tool that checks if the package is using internals (#349)
  • Handle optional non-recommended questions better (#490)
  • Add main branch protection to "Setting up your package" (#506)

v0.13.0

11 Oct 10:47
Compare
Choose a tag to compare

BestieTemplate v0.13.0

Diff since v0.12.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 running update)
    • You must manually change Project.toml
    • You might have to manually change Test.yml and/or TestOnPRs.yml in the folder .github/workflows

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:

Closed issues:

  • Clean up whitespaces (#445)
  • [Bug] On tags, Test.yml breaks for updating from main to HEAD vs generate in HEAD is broken (#454)
  • Update LTS (#486)

v0.12.0

08 Oct 14:44
Compare
Choose a tag to compare

BestieTemplate v0.12.0

Diff since v0.11.0

Merged pull requests:

Closed issues:

  • Split indentation into JuliaIndentation, MarkdownIndentation, ConfigIndentation (#460)

v0.11.0

07 Oct 12:04
Compare
Choose a tag to compare

BestieTemplate v0.11.0

Diff since v0.10.1

Merged pull requests:

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

10 Sep 10:38
Compare
Choose a tag to compare

BestieTemplate v0.10.1

Diff since v0.10.0

Fixed

  • The TestGeneratedPkg workflow now runs the latest unreleased version of the pkg (#450)
  • The tests of the generated package correctly include the test-*.jl files (#452)

v0.10.0

10 Sep 09:36
Compare
Choose a tag to compare

BestieTemplate v0.10.0

Diff since v0.9.1

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:

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 the AuthorEmail (#426)
  • Add a LicenseHolders question to decouple it from the AuthorName (#427)
  • Document deprecation of a question. (#428)
  • [Bug] Tests are broken on main due to git command in workflow (#435)

v0.9.1

24 Jul 09:59
Compare
Choose a tag to compare

BestieTemplate v0.9.1

Diff since v0.9.0

Merged pull requests:

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

13 Jul 12:00
Compare
Choose a tag to compare

BestieTemplate v0.9.0

Diff since v0.8.0

Merged pull requests:

Closed issues:

  • [Bug] Error when running the documentation for a new package (#289)
  • Clean up docs/make.jl (#357)
  • Change JuliaFormatter to have only indent (#358)

v0.8.0

08 Jul 21:37
Compare
Choose a tag to compare

BestieTemplate v0.8.0

Diff since v0.7.2

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 function apply 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:

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)