repo_helper.core
¶
Core functionality of repo_helper
.
Classes:
|
Repo Helper: Manage configuration files with ease. |
Functions:
Returns a list of all registered functions. |
-
class
RepoHelper
(target_repo, managed_message="This file is managed by 'repo_helper'. Don't edit it directly.")[source]¶ Repo Helper: Manage configuration files with ease.
- Parameters
Attributes:
A tuple of excluded files that should NOT be managed by Git Helper.
List of functions to manage files.
Message placed at the top of files to indicate that they are managed by
repo_helper
.The name of the repository being managed.
The target repository
Provides the templates and stores the configuration.
Methods:
load_settings
([allow_unknown_keys])Load settings from the
repo_helper.yml
file in the repository.run
()Run Git Helper for the repository and update all managed files.
-
property
exclude_files
¶ A tuple of excluded files that should NOT be managed by Git Helper.
-
files
¶ Type:
Management
List of functions to manage files.
-
load_settings
(allow_unknown_keys=False)[source]¶ Load settings from the
repo_helper.yml
file in the repository.- Parameters
allow_unknown_keys (
bool
) – Whether unknown keys should be allowed in the configuration file. DefaultFalse
.
Changed in version 2021.2.18:This method is no longer called automatically when instantiating the
RepoHelper
class.Added the
allow_unknown_keys
argument.
-
property
managed_message
¶ Message placed at the top of files to indicate that they are managed by
repo_helper
.- Return type
-
templates
¶ Type:
Environment
Provides the templates and stores the configuration.