v0.4.2

Release Notes v0.4.2

The full changelog can be found here.

What's Changed

• Use os.walk() to efficiently skip ignored directories and subpaths.
• Compare paths logically to avoid repeated system calls.
• Resolve paths at initialization to avoid repeated resolves later.

Reasoning

• Improving directory traversal performance.

v0.4.1

Release Notes v0.4.1

The full changelog can be found here.

What's Changed

Utilizing git bindings instead of processing raw string output.

Reasoning

• Cleaner than the prior approach.
• Makes future features easier and more transparent to implement.

v0.4.0

Release Notes v0.4.0

The full changelog can be found here.

What's Changed

1. Performance improvement. Looking up git repositories is now faster.

Reasoning

• Performance thus far was not adequate for the tool's intended use case.

v0.3.3

Release Notes v0.3.3

The full changelog can be found here.

What's Changed

1. Visual overhaul: output is now visually more appealing.

Reasoning

• No. 1 is for the looks, because looks.

v0.3.2

Release Notes v0.3.2

The full changelog can be found here.

What's Changed

1. Configuration files on MacOS are now correctly identified and used.

Reasoning

• Duh.

v0.3.1

Release Notes v0.3.1

The full changelog can be found here.

What's Changed

1. More details on usage in README.md.
2. The --version flag now displays the correct version number.

Reasoning

• No.1 for easier usage.
• No.2 was a necessary change.

v0.3.0

Release Notes v0.3.0

The full changelog can be found here.

What's Changed

1. Added support for configuring Git Alert using a TOML configuration file.
2. Can be overridden by specifying a custom path.

Reasoning

• No. 1 for persistent application settings.
• No. 2 for trying out configurations/ use different configuration on a per call basis.

v0.2.1

Release Notes v0.2.1

The full changelog can be found here.

What's Changed

1. Added default.nix for building the application with nix-build.
2. Reworked the flake.nix so it references default.nix.

Reasoning

- No. 1 and No.2 allow for conventional nix builds that fetch the source from PyPi rather than the latest commit on GitHub.

v0.2.0

Release Notes v0.2.0

The full changelog can be found here.

What's Changed

1. .traverse() of GitAlert does not invoke .check() itself. Hence,
   .check() needs to be invoked separately (breaking change).
2. .check() now checks all repositories in the list of repositories and
   updates their entry accordingly (breaking change).
3. .repos of Repositories is now of the following form:
   dict[dict[str, str]] = []. Each key in the directory is equal to the
   path of the repository. Hence, uniquely identifying repositories in the
   dictionary and allowing for faster look-ups.
4. .traverse() performance improvement by looking for .git
   directories in each directory instead of looping through directories
   until a .git directory is found. This also means that nested git
   repositories (.git directories in sub-directories of a directory
   containing a .git directory) are excluded. In general, nesting git
   repositories is not a good idea and preliminary testing showed
   significant performance increases, hence the change.
5. New feature: it is now possible to additionally pass a list of
   directories that shall be excluded by git_alert. To be excluded paths
   can be passed in with a new flag: --ignore /path/one:/path/two
6. Git Alert now keeps track of the number of found repositories and the
   number of dirty repositories and prints a short summary containing this
   information.

Reasoning

• No. 1 and No. 2 separate traversing the file system from checking
  individual found repositories.
• No. 3 The new representation of repositories allows for easier access
  to data on repositories. Also looking up one specific repository is now
  faster.
• No. 4 Go burr!
• No. 5 Excluding directories reduces runtime.
• No. 6 Enables short descriptive summaries and also enables new angles
  for testing.

v0.1.0

Initial Release

This tool is in rapid development. Hence, breaking changes in the short term are to be expected (more in future release notes).

Full Changelog: https://github.com/nomisreual/git_alert/commits/v0.1.0