rezplugins.release_vcs.stub

Stub version control system, for testing purposes

class rezplugins.release_vcs.stub.StubReleaseVCS(pkg_root, vcs_root=None)

Bases: rez.release_vcs.ReleaseVCS

A release VCS that doesn’t really do anything. Used by unit tests.

A writable ‘.stub’ file must be present in the project root. Any created tags are written to this yaml file.

create_release_tag(tag_name, message=None)

Create a tag in the repo.

Create a tag in the repository representing the release of the given version.

Parameters

• tag_name (str) – Tag name to write to the repo.

• message (str) – Message string to associate with the release.

get_changelog(previous_revision=None, max_revisions=None)

Get the changelog text since the given revision.

If previous_revision is not an ancestor (for example, the last release was from a different branch) you should still return a meaningful changelog - perhaps include a warning, and give changelog back to the last common ancestor.

Parameters

• previous_revision – The revision to give the changelog since. If

• None –

• changelog. (give the entire) –

Returns

Changelog, as a string.

get_current_revision()

Get the current revision, this can be any type (str, dict etc) appropriate to your VCS implementation.

Note

You must ensure that a revision contains enough information to clone/export/checkout the repo elsewhere - otherwise you will not be able to implement export.

classmethod is_valid_root(path)

Return True if the given path is a valid root directory for this version control system.

Note that this is different than whether the path is under the control of this type of vcs; to answer that question, use find_vcs_root

classmethod name()

Return the name of the VCS type, eg ‘git’.

classmethod search_parents_for_root()

Return True if this vcs type should check parent directories to find the root directory

tag_exists(tag_name)

Test if a tag exists in the repo.

Parameters

tag_name (str) – Tag name to check for.

Returns

True if the tag exists, False otherwise.

Return type

bool

validate_repostate()

Ensure that the VCS working copy is up-to-date.

rezplugins.release_vcs.stub.register_plugin()