conradbzura / railyard-bootstrap Goto Github PK

To simplify the public interface of the railyard.bootstrap.version module, the plugin registry method should be moved from VersionParser to Version.

Description

Python source distributions (i.e. those generated using sdist) should be supported by Railyard Bootstrap's revision tagging feature.

Assumptions

• sdist is the only command class used in Python 3 to generate source distributions.
• Users may have their own implementations of sdist.
• Source distributions have a root package directory.

Requirements

• Railyard Bootstrap's implementation of sdist should preserve any pre-existing functionality of the command class, user-defined or otherwise.
• The source code should have access to the dynamic, git-derived version.
• The generated source distribution should have access to the static, git-derived version frozen at distribution time.
• The version should be importable from the root package.

Python 3.8+ provides a means of accessing distribution metadata which includes the distribution version, rendering the setuptools wrapper and custom command classes unnecessary.

Railyard Bootstrap's automated revision tagging relies upon the ability to generate a version identifier based on a recent Git tag or the current Git revision. An interactive version container type should be implemented to enforce the PEP 440 standard and make it easy to parse a PEP 440-compliant version string into its component parts. The type should handle incrementing individual version segments such that any less significant segments are reset to their defaults.

The automated revision tagging parser should be extensible via plugins. This will allow users to implement support for their version control or build system of choice.