0.16.0 Release Plan

[jorisroovers]

I just released 0.15.0 🎉 Thanks again to everyone contributing!

This issue will be used to track any overarching discussion and work related to 0.16.0.

Scope

As always, everything discussed in this issue is subject to sudden change at my sole discretion. No promises or hard commitments :-)

All related issues will be tagged with the 0.16.0 Milestone.

Here's a few things I've been thinking about (most don't have an associated issue) as potential areas to work on next.

• Consider moving gitlint under PyCQA. Still not sure at this point (Future project maintenance #134)
• Add --commit flag: Add --commit flag to more easily lint a single commit #141
• Don't have both requirements.txt and dependencies in setup.py, deduplicate
• User-defined OutputFormatter classes to allow users to specify the format of the output. Would allow us to easily implement Custom note to explain title-match-regex rule. #45 and Change formatting #53.
  • OutputFormatter classes would just be found in the --extra-path
• GitContext.config(name, default=None, use_cache=True) method for easy access to git config (that is also cached). Optionally also provide a mechanism for easy fallback. E.g. default can be a string and/or a lambda that implements more complex logic like returning from environment config.
• New Rule: ConfigRule: git config commands
  • This can just be implemented as a commit rule that just runs a _git command (or GitContext.config - see above) to pull the value and then compare it to a given regex. By using named rules, users can implement multiple of such rules.
• Respect git config core.editor for commit msg editing instead of only falling back to vim if $EDITOR isn't set
• gitlint github action
• Attempt to fix coveralls.io integration with Github Actions (see .github/workflows/checks.yml#L60-L66)
• Windows: work a bit on fixing existing issues
• Move to Poetry for packaging/building?
• Unit Tests: fix running on Windows, try again :-)

Timeline

As always, no specific timeline, but probably in the new year (2021).

[gsemet]

Can you release and intermediate version please?

[jorisroovers]

Planning to release 0.15.1 in the coming week with the merged fixes and dependency upgrades.

[jorisroovers]

I haven't forgotten (for 0.15.1 release) but life got in the way... Still would like to do so soonish but no idea when I'll be able to make the time.

[gsemet]

I know that :) but if the current state is fine, why not releasing it as it is and then prepare a bigger maybe 0.17 ;)

[jorisroovers]

I'm not talking about adding more features or fixes, just about making the time (and mostly finding the energy/will after work and everything else) to get the release out. Maybe this weekend :)

[jorisroovers]

Just released 0.15.1 🎉

• CHANGELOG: https://github.com/jorisroovers/gitlint/blob/v0.15.1/CHANGELOG.md
• Github Release: https://github.com/jorisroovers/gitlint/releases/tag/v0.15.1
• Pypi: https://pypi.org/project/gitlint/0.15.1/
• Dockerhub: https://hub.docker.com/repository/docker/jorisroovers/gitlint

@harens FYI, if you're up for updating homebrew and macports (no pressure, super thanks!)

[harens]

All done on my side @jorisroovers 👍. Thanks for the new release.

MacPorts: macports/macports-ports@6d3b768
Homebrew: Homebrew/homebrew-core#75325 (credit to @dtrodrigues)

[jorisroovers]

I'm planning to release 0.16.0 over the next week or so. Initially wanted to make it 0.15.2 but changed my mind since I committed a few minor new features today.

Won't get to most of the scope listed above - that will be deferred to 0.17.0 or beyond. Hoping to merge a few PRs still, but might just release without much more than is currently merged.

cc: @sigmavirus24 (let me know if there's anything you want to get it)

[jorisroovers]

I've just released 0.16.0 🎉

Still need to clean up github milestone and this issue (and move things over to 0.17.0, etc), will do that over next few days.

@harens if you would be so kind to update the packages? Super thanks!

[harens]

@harens if you would be so kind to update the packages? Super thanks!

All done on my side. Thank you @jorisroovers for maintaining this amazing project! ⭐ Your work is greatly appreciated.

🍎 MacPorts: macports/macports-ports@85f8bb5
🍺 Homebrew: Homebrew/homebrew-core#86892