Changelog

This file contains a brief summary of new features and dependency changes or releases, in reverse chronological order.

0.7.0 (2024-11-30)

Breaking Changes

  • Dropped support for Python 3.8 due to end-of-life status. Python 3.8 reached its end-of-life date in October 2024, which means it will no longer receive bug fixes or security updates from the Python development team. As a result, the support for Python 3.8 was removed in order to ensure the ongoing security and stability of our package. Users who require Python 3.8 can continue to use older package versions that support it.

Trivial/Internal Changes

  • Migrate project infrastructure to poetry.

  • Bumped furo from 2022.12.7 to 2024.8.6.

  • Bumped pygithub from 1.58.0 to 2.5.0.

  • Bumped gitpython from 3.1.17 to 3.1.43.

0.6.1 (2023-03-02)

Bug Fixes

  • Corrected furo version definition in setup.py.

0.6.0 (2023-03-02)

Breaking Changes

  • Dropped support for Python 3.7 due to end-of-life status. Python 3.7 reached its end-of-life date in June 2023, which means it will no longer receive bug fixes or security updates from the Python development team. As a result, I have removed support for Python 3.7 in order to ensure the ongoing security and stability of our package. Users who require Python 3.7 can continue to use older package versions that support it.

Trivial/Internal Changes

  • Bumped check-manifest from 0.48 to 0.49.

  • Bumped coverage from 6.3.2 to 7.2.1.

  • Bumped furo from 2020.12 to 2022.12.7.

  • Bumped gitpython from 3.1.17 to 3.1.31.

  • Bumped pygithub from 1.57 to 1.58.0.

  • Bumped pylint from 2.13.5 to 2.16.2.

  • Bumped pytest from 7.1.1 to 7.2.1.

  • Bumped sphinx from 4.3.2 to 6.1.3.

0.5.0 (2021-05-07)

Features

  • Introduced ability to specify the maximum number of concurrent processes to use when syncing.

Improvements

  • Reformat log entries to provide logs in a bit more readable format as well as process id (PID).

  • Changed additional groups of dependencies declared in setup.py so that develop is superset now for testing and docs.

  • Remove dependencies from develop group which are not necessary for developing the package.

  • Used single requirements.txt file to declare project dependencies. Additional dependencies from develop, testing and docs groups lives now in setup.py or tox.ini.

Bug Fixes

  • Added missed files to the package contents.

  • Don’t include tests package in wheel. Previously pip install gstore used to install a top-level package tests. This was fixed.

  • Fixed package description.

Trivial/Internal Changes

  • Replaced pytest-cov by coverage[toml] for code coverage measurement.

  • Bumped pygithub from 1.54.1 to 1.55.

0.4.0 (2021-02-19)

Features

  • The gstore.env module was introduced to provide a convenient way to work with environment variables used by various functions within gstore.

  • Added the following functions within gstore.env:

    • lookup_token() - lookup a personal access token in environment variables,

    • get_host() - get GitHub API hostname from environment variable,

    • get_target() - get base target to sync repos from environment variable.

Breaking Changes

  • Moved gstore.Client.TOKEN_NAMES to gstore.env.TOKEN_NAMES.

  • Moved gstore.args.get_token_from_env() to gstore.env.lookup_token().

Improvements

  • Improved git.GitCommandError message formatting for more accurate logging.

  • The program now correctly handle Control-C keyboard event and gracefully terminates.

  • gstore will exit with a status of one when its is called without any argument and there are not enough environment variables for normal operation.

  • Calling program with an invalid token and without --org option no longer leads to abnormal program termination.

Trivial/Internal Changes

  • gstore.Client.__init__() will raise now gstore.client.ValidationError when no token is provided.

  • gstore.Client.resolve_orgs() will raise now gstore.client.InvalidCredentialsError when provided token is invalid.

0.3.1 (2021-01-03)

Improvements

  • gstore will exit with a status of one if there are critical errors during synchronization.

  • gstore will handle situations with invalid API token or organization name.

Improved Documentation

Bug Fixes

  • Fixed gstore.args.get_token_from_env() to properly get a token from environment variables or None if variables are not set.

Trivial/Internal Changes

  • gstore.Client.__init__(), as well as gstore.Client.resolve_orgs() will raise now gstore.exceptions.InvalidCredentialsError in case of incorrect credentials usage.

  • gstore.models.Repository now holds gstore.models.Organization.

  • Starting with v0.3.1 tests will be included in the PyPI package.

0.3.0 (2021-01-03)

Breaking Changes

  • Python < 3.7 is no longer supported.

  • Changed the way to get repositories from specific organizations. From now, to get repositories from specific organizations, list each of them on the command line using the argument --org.

Features

  • Added -o as a short form of --org argument.

  • Added ability to limit sync to the specified repositories using -r, --repo option.

Improvements

  • Improved logging and error reporting.

  • Improved local repo handling by checking the directory contents.

Bug Fixes

  • Corrected log level on --quiet mode.

  • Fixed invalid local repo handling.

0.2.0 (2020-12-27)

Features

  • Added ability to specify host for Github Enterprise.

Improvements

  • Show help message and exit when gstore is called without any argument and there are not enough environment variables for normal operation.

0.1.1 (2020-12-27)

Features

  • Added -V, --version arguments to print program’s version information.

  • Added -dumpversion argument to print the version of the program and don’t do anything else.

  • Added -q, --quiet arguments to silence any informational messages except error ones

Improvements

  • Handling situations when the target for sync is a regular file or readonly.

0.1.0 (2020-12-26)

Features

  • Provided ability to pass authentication token for github.com API requests via environment variables.

  • Added -v argument support to enable verbose mode.

Breaking Changes

  • The GitHub username is no longer used upon obtaining organizations list.

Trivial/Internal Changes

  • Changed the way to communicate with GitHub API. requests library no longer used thanks to PyGithub.

0.0.5 (2020-12-25)

Features

  • Added better logging subsystem

Trivial/Internal Changes

0.0.4 (2020-12-24)

Breaking Changes

  • Renamed GHS_DIR environment variable to GSTORE_DIR.

  • Renamed package name from ghs to gstore to avoid collision with the existing package with the same name.

0.0.3 (2020-12-24)

Features

  • Added ability to use GHS_DIR as a sync base directory.

  • Added ability to omit target directory and use current working directory.

  • Added ability to fetch objects and refs from an existent repository.

0.0.2 (2020-12-24)

Breaking Changes

  • Renamed package name from ghsync to ghs to avoid collision with the existing package with the same name.

0.0.1 (2020-12-23)

  • Initial release.