v2.2.0

🔄 Upgraded Version Management with bump-my-version & 🐛 Fixed IndexError in File History Parsing

Changed

• Switched from bump2version to the maintained fork bump-my-version. See #95 for more details. Thanks to @MattF-NSIDC for the suggestion!

Removed

• Removed .bumpversion.cfg in favor of configuring bump-my-version in pyproject.toml. See #95 for more details.

Fixed

• Fixed a bug in the file version history parser that would lead to a IndexError when multiple changes were made to files in a single commit. See #102 for more details.

v2.1.0

🆕 CHANGELOG.md, token guides, dependency fixes and gracefull error handling ahead in gitlab2prov v2.1.0!

Added

• CHANGELOG.md file to document all notable changes to this project.
• README.md section on how to get started with gitlab2prov.
• README.md note that gitlab2prov requires a git installation.
• README.md section on dependencies and their respective licenses. See #91 for more details.
• pyproject.toml comments documenting the license information of all dependencies. See #91 for more details.
• Project documentation on how to obtain a GitLab API token.

Changed

• Tool will check for a git installation and exit with an error message if none is found. See #93 for more details.

Fixed

• Click package is now listed as a dependency in pyproject.toml. Thank you @daniel-mohr for reporting this oversight.

v2.0.0

🎉 gitlab2prov v2.0.0 is here! This major release comes packed with exciting new features, including a new command line interface and configuration file format that allows users to specify their desired actions as a pipeline. In addition, the release also includes a new build system that reduces the number of necessary metadata files.

Added

• New command line interface composed of multiple subcommands that can be chained together to build any desired gitlab2prov pipeline.
• New YAML configuration file format to specify gitlab2prov pipelines in textual format and save them for later reruns or simple on-the-fly edits.
• JSON-Schema file to check the config file for syntactical errors.
• bumpversion support to change the version number with a single command.

Changed

• New build system that minimizes the number of necessary metadata files.
• New CLI replaces the old CLI.
• New config file format replaces the old config file format.
• Deprecate setup.py, setup.cfg in favor of pyproject.toml. See #70 for more details.

Fixed

• Tool runs on Windows should no longer trigger WinError 5/267. See #67.
• Special characters such as emojis no longer trigger a UnicodeEncodeError when serializing files. See #66.

v1.1.4

🆕 v1.1.4 is now available, featuring an updated citation file, a new GitHub workflow for citation file validation, and a bug fix for pseudonymization of provenance graphs.

Added

• A GitHub workflow to validate the citation file on changes.

Changed

• Current version and release date in citation file.

Fixed

• Update the start- and endpoint of relations during pseudonymization.
• User details and agent IDs are pseudonymized using hashing for flexible pseudonymization and merging of provenance graphs (#62).

v1.1.3

🐛 v1.1.3 includes a bug fix for FileRevision objects in the modification model, preventing a TypeError when serializing objects without a previous revision.

Fixed

• FileRevision objects that do not have a previous revision no longer lead to a TypeError when serializing the modification model. (see #64)

v1.1.2

🐛 v1.1.2 includes bug fixes for the fallback classifier for system notes and retrieval issues with disabled project features.

Fixed

• Disable project features no longer lead to a 403 Forbidden. (see #61)
• Default annotation classifier no longer keys into a dictionary resulting in a KeyError (#63)

v1.1.1

🐛 v1.1.1 includes bug fixes for a memory bloating issue and spelling mistakes

Fixed

• Fix a memory bloating issue by not using mutable objects as function argument default value (see #60)
• Fix a spelling mistake in config.formats to config.format

v1.1

🚀 v1.1 introduces multi-format support for provenance graph serialization.

Added

• Multi-format support for provenance graph serialization supported by the multi-format subcommand. (see #54)
• outfile option to section OUTPUT in the config file to specify the output file name.

Changed

• README now includes a section about multi-format serialization.

v1.0

🎉 gitlab2prov v1.0 is here! This major release introduces a new hybrid data retrieval approach using both the python-gitlab package and Git, resulting in synchronous processing. The package structure has undergone a drastic rewrite, including the adoption of a message bus architecture for future features. New features include qualified relations, logging, profiling, and a test suite, while bug fixes improve event classification and handling of missing event classifiers.

Added

• Qualified relations for relationship types wasGeneratedBy, wasInvalidatedBy, used, wasAssociatedWith (see #52)
• Command line flag --v enables logging to the console.
• Command line flag --profile enables profiling of a tool run.
• Test suite.
• Documentation for config file options in the config file example.
• Model documentation including descriptions of each node and relationship with their respective properties.
• requirements_dev.txt to install development dependencies.

Fixed

• Releases without evidence no longer lead to IndexError. (see #53)
• Processing parent commits no longer leads to errors. (#37)
• Missing event classifiers are now handled gracefully. (#38)

Changed

• Support comma-seperated lists of URLs for config file option project_urls.
• Rename aliases to double_agents in the config file and command line interface.
• Rename pseudonymize to pseudonymous in the config file and command line interface.
• Rename the config file sections to match the new CLI subcommands
• Stop manual file history computation. Each file revision now has exactly one previous revision instead of one or more.
• Use the modification model for commit statuses: MODIFIED, RENAMED, COPIED, CHANGED.
• Ignore file revisions with unkown commit status.
• Change event classification to use the package regex that supports branch reset expressions.
• Change build process to use pyproject.toml aswell as setup.cfg
• Change architecture to messagebus in anticipation of future features.
• Bump minimum required prov version to 2.0.0

Removed

• Rate limit flag/option --r/rate_limit. Asynchronicity during retrieval is no longer supported.
• Quiet flag/option --q/quiet. Default behavior is to be quiet by default unless the --v flag is set.

v0.5

🆕🔖 The v0.5 release adds support for tags and releases with a new PROV model and fixes a bug concerning API pagination. It also includes a CITATION file in CFF.

Added

• Support for 'tags' and 'releases' to PROV model (see #39)
• CITATION file in Citation File Format (CFF) (see #49)

Changed

• Revisions (changes) of files expressed in PROV model (see #40)

Fixed

• API client pagination (see #41)
• 'wasGeneratedBy' relation for 'tags' corrected (see #51)

Removed

• Resource names from attributes (see #47, #48)