Index

Symbols

--branch-override generate-changelog command line option --config generate-changelog command line option --generate-config generate-changelog command line option --install-completion generate-changelog command line option --output generate-changelog command line option --repo-path generate-changelog command line option --show-completion generate-changelog command line option --skip-output-pipeline generate-changelog command line option

--starting-tag generate-changelog command line option --version generate-changelog command line option -b generate-changelog command line option -c generate-changelog command line option -o generate-changelog command line option -r generate-changelog command line option -t generate-changelog command line option

_

__call__() (generate_changelog.actions.file_processing.IncrementalFileInsert method) (generate_changelog.actions.file_processing.ReadFile method) (generate_changelog.actions.file_processing.WriteFile method) (generate_changelog.actions.matching.MetadataMatch method) (generate_changelog.actions.matching.SummaryRegexMatch method) (generate_changelog.actions.metadata.MetadataCollector method) (generate_changelog.actions.metadata.ParseBreakingChangeFooter method) (generate_changelog.actions.metadata.ParseConventionalCommit method) (generate_changelog.actions.metadata.ParseIssue method) (generate_changelog.actions.metadata.ParseTrailers method) (generate_changelog.actions.text_processing.AppendString method) (generate_changelog.actions.text_processing.FirstRegExMatch method) (generate_changelog.actions.text_processing.FirstRegExMatchPosition method) (generate_changelog.actions.text_processing.PrefixLines method) (generate_changelog.actions.text_processing.PrefixString method) (generate_changelog.actions.text_processing.RegexSub method) (generate_changelog.actions.text_processing.SetDefault method) (generate_changelog.actions.text_processing.Slice method) (generate_changelog.actions.text_processing.Strip method) (generate_changelog.actions.text_processing.WrapParagraphs method) (generate_changelog.release_hint.ReleaseRule method) (generate_changelog.release_hint.RuleProcessor method) __contains__() (generate_changelog.actions.Registry method) __getitem__() (generate_changelog.actions.Registry method) __init__() (generate_changelog.actions.file_processing.IncrementalFileInsert method) (generate_changelog.actions.file_processing.ReadFile method) (generate_changelog.actions.file_processing.WriteFile method) (generate_changelog.actions.matching.MetadataMatch method) (generate_changelog.actions.matching.SummaryRegexMatch method) (generate_changelog.actions.metadata.MetadataCollector method) (generate_changelog.actions.metadata.ParseBreakingChangeFooter method) (generate_changelog.actions.metadata.ParseConventionalCommit method) (generate_changelog.actions.metadata.ParseIssue method) (generate_changelog.actions.metadata.ParseTrailers method) (generate_changelog.actions.Registry method) (generate_changelog.actions.text_processing.AppendString method) (generate_changelog.actions.text_processing.FirstRegExMatch method) (generate_changelog.actions.text_processing.FirstRegExMatchPosition method) (generate_changelog.actions.text_processing.PrefixLines method) (generate_changelog.actions.text_processing.PrefixString method) (generate_changelog.actions.text_processing.RegExCommand method) (generate_changelog.actions.text_processing.RegexSub method) (generate_changelog.actions.text_processing.SetDefault method) (generate_changelog.actions.text_processing.Slice method) (generate_changelog.actions.text_processing.Strip method) (generate_changelog.actions.text_processing.WrapParagraphs method) (generate_changelog.configuration.Configuration method) (generate_changelog.context.ChangelogContext method) (generate_changelog.context.CommitContext method) (generate_changelog.context.GroupingContext method) (generate_changelog.context.VersionContext method) (generate_changelog.git_ops.GitTag method) (generate_changelog.git_ops.TagInfo method) (generate_changelog.pipeline.Action method) (generate_changelog.pipeline.Pipeline method) (generate_changelog.release_hint.InvalidRuleError method) (generate_changelog.release_hint.ReleaseRule method) (generate_changelog.release_hint.RuleProcessor method) (generate_changelog.templating.RenderedChangelog method)

__new__() (generate_changelog.cli.OutputOption method) (generate_changelog.release_hint.InvalidRuleError method) __post_init__() (generate_changelog.context.CommitContext method) _generate_next_value_() (generate_changelog.cli.OutputOption method)

A

Action (class in generate_changelog.pipeline) actions (generate_changelog.pipeline.Pipeline attribute) all (generate_changelog.cli.OutputOption attribute) AppendString (class in generate_changelog.actions.text_processing)

as_dict() (generate_changelog.context.ChangelogContext method) ascii_flag (generate_changelog.actions.text_processing.RegExCommand attribute) attribute_docstrings() (in module generate_changelog._attr_docs) author_names (generate_changelog.context.CommitContext property) authors (generate_changelog.context.CommitContext property)

B

bash() (in module generate_changelog.actions.shell)

body (generate_changelog.context.CommitContext attribute) body_pipeline (generate_changelog.configuration.Configuration attribute)

C

capitalize() (in module generate_changelog.actions.text_processing) ChangelogContext (class in generate_changelog.context) chars (generate_changelog.actions.text_processing.Strip attribute) commit (generate_changelog.git_ops.TagInfo attribute) commit_classifiers (generate_changelog.configuration.Configuration attribute) commit_datetime (generate_changelog.context.CommitContext attribute) commit_metadata_func (generate_changelog.pipeline.Action attribute) CommitContext (class in generate_changelog.context)

commits (generate_changelog.context.GroupingContext attribute) (generate_changelog.git_ops.GitTag attribute) committer (generate_changelog.context.CommitContext attribute) comprehensive_merge() (in module generate_changelog.data_merge) config (generate_changelog.context.ChangelogContext attribute) Configuration (class in generate_changelog.configuration) context (generate_changelog.pipeline.Pipeline attribute) create_if_missing (generate_changelog.actions.file_processing.ReadFile attribute) create_version_context() (in module generate_changelog.commits)

D

date_string (generate_changelog.git_ops.TagInfo property) date_time (generate_changelog.context.VersionContext attribute) deep_merge() (in module generate_changelog.data_merge) default (generate_changelog.actions.text_processing.SetDefault attribute)

default_value (generate_changelog.actions.text_processing.FirstRegExMatch attribute) diff_index (generate_changelog.context.ChangelogContext attribute) diff_index() (in module generate_changelog.utilities) dotall_flag (generate_changelog.actions.text_processing.RegExCommand attribute)

E

echo() (in module generate_changelog.cli)

eval_if_callable() (in module generate_changelog.utilities)

F

filename (generate_changelog.actions.file_processing.IncrementalFileInsert attribute) (generate_changelog.actions.file_processing.ReadFile attribute) (generate_changelog.actions.file_processing.WriteFile attribute) files (generate_changelog.context.CommitContext attribute) first_line (generate_changelog.actions.text_processing.PrefixLines attribute)

first_matching() (in module generate_changelog.commits) FirstRegExMatch (class in generate_changelog.actions.text_processing) FirstRegExMatchPosition (class in generate_changelog.actions.text_processing) flags (generate_changelog.actions.text_processing.RegExCommand property) full (generate_changelog.templating.RenderedChangelog attribute)

G

generate-changelog command line option --branch-override --config --generate-config --install-completion --output --repo-path --show-completion --skip-output-pipeline --starting-tag --version -b -c -o -r -t generate_changelog._attr_docs module generate_changelog.actions module generate_changelog.actions.file_processing module generate_changelog.actions.matching module generate_changelog.actions.metadata module generate_changelog.actions.shell module generate_changelog.actions.text_processing module generate_changelog.cli module generate_changelog.commits module

generate_changelog.configuration module generate_changelog.context module generate_changelog.data_merge module generate_changelog.git_ops module generate_changelog.pipeline module generate_changelog.release_hint module generate_changelog.templating module generate_changelog.utilities module generate_commit_context() (in module generate_changelog.commits) generate_config_callback() (in module generate_changelog.cli) get_commits_by_tags() (in module generate_changelog.git_ops) get_config() (in module generate_changelog.configuration) get_context_from_tags() (in module generate_changelog.commits) get_default_config() (in module generate_changelog.configuration) get_default_env() (in module generate_changelog.templating) get_pipeline_env() (in module generate_changelog.templating) get_repo() (in module generate_changelog.git_ops) get_tags() (in module generate_changelog.git_ops) get_user_config() (in module generate_changelog.cli) GitTag (class in generate_changelog.git_ops) group_by (generate_changelog.configuration.Configuration attribute) (generate_changelog.context.ChangelogContext attribute) group_depth (generate_changelog.context.ChangelogContext attribute) grouped_commits (generate_changelog.context.VersionContext attribute) grouping (generate_changelog.context.CommitContext attribute) (generate_changelog.context.GroupingContext attribute) GroupingContext (class in generate_changelog.context)

H

heading (generate_changelog.templating.RenderedChangelog attribute)

I

id (generate_changelog.pipeline.Action attribute) ignore_patterns (generate_changelog.configuration.Configuration attribute) ignorecase_flag (generate_changelog.actions.text_processing.RegExCommand attribute) import_function() (in module generate_changelog.pipeline) include_merges (generate_changelog.configuration.Configuration attribute) IncrementalFileInsert (class in generate_changelog.actions.file_processing)

InvalidRuleError is_action() (in module generate_changelog.utilities) is_pipeline() (in module generate_changelog.utilities) issue_pattern (generate_changelog.actions.metadata.ParseAzureBoardIssue attribute) (generate_changelog.actions.metadata.ParseGitHubIssue attribute) (generate_changelog.actions.metadata.ParseIssue attribute) (generate_changelog.actions.metadata.ParseJiraIssue attribute)

L

label (generate_changelog.context.VersionContext attribute) last_heading_pattern (generate_changelog.actions.file_processing.IncrementalFileInsert attribute)

load_builtins() (generate_changelog.actions.Registry method) locale_flag (generate_changelog.actions.text_processing.RegExCommand attribute)

M

main() (in module generate_changelog.cli) matches_branch() (generate_changelog.release_hint.ReleaseRule method) matches_grouping() (generate_changelog.release_hint.ReleaseRule method) matches_path() (generate_changelog.release_hint.ReleaseRule method) merge_iterables() (in module generate_changelog.data_merge) metadata (generate_changelog.actions.metadata.MetadataCollector attribute) (generate_changelog.context.CommitContext attribute) (generate_changelog.context.VersionContext attribute) MetadataCollector (class in generate_changelog.actions.metadata) MetadataMatch (class in generate_changelog.actions.matching) module generate_changelog._attr_docs generate_changelog.actions generate_changelog.actions.file_processing generate_changelog.actions.matching generate_changelog.actions.metadata generate_changelog.actions.shell generate_changelog.actions.text_processing generate_changelog.cli generate_changelog.commits generate_changelog.configuration generate_changelog.context generate_changelog.data_merge generate_changelog.git_ops generate_changelog.pipeline generate_changelog.release_hint generate_changelog.templating generate_changelog.utilities

multiline_flag (generate_changelog.actions.text_processing.RegExCommand attribute)

N

name (generate_changelog.git_ops.TagInfo attribute) named_subgroup (generate_changelog.actions.text_processing.FirstRegExMatch attribute)

noop_func() (in module generate_changelog.pipeline) notes (generate_changelog.cli.OutputOption attribute) (generate_changelog.templating.RenderedChangelog attribute)

O

operator_map (generate_changelog.actions.matching.MetadataMatch attribute)

output_pipeline (generate_changelog.configuration.Configuration attribute) OutputOption (class in generate_changelog.cli)

P

pairs() (in module generate_changelog.utilities) paragraph_join (generate_changelog.actions.text_processing.WrapParagraphs attribute) paragraph_pattern (generate_changelog.actions.text_processing.WrapParagraphs attribute) parse_commits() (in module generate_changelog.git_ops) ParseAzureBoardIssue (class in generate_changelog.actions.metadata) ParseBreakingChangeFooter (class in generate_changelog.actions.metadata) ParseConventionalCommit (class in generate_changelog.actions.metadata) ParseGitHubIssue (class in generate_changelog.actions.metadata) ParseIssue (class in generate_changelog.actions.metadata) ParseJiraIssue (class in generate_changelog.actions.metadata)

ParseTrailers (class in generate_changelog.actions.metadata) pattern (generate_changelog.actions.text_processing.RegExCommand attribute) Pipeline (class in generate_changelog.pipeline) pipeline_factory() (in module generate_changelog.pipeline) postfix (generate_changelog.actions.text_processing.AppendString attribute) prefix (generate_changelog.actions.text_processing.PrefixLines attribute) (generate_changelog.actions.text_processing.PrefixString attribute) PrefixLines (class in generate_changelog.actions.text_processing) PrefixString (class in generate_changelog.actions.text_processing) previous_tag (generate_changelog.context.VersionContext attribute)

R

ReadFile (class in generate_changelog.actions.file_processing) RegExCommand (class in generate_changelog.actions.text_processing) RegexSub (class in generate_changelog.actions.text_processing) register_builtin() (in module generate_changelog.actions) Registry (class in generate_changelog.actions) release_hint (generate_changelog.cli.OutputOption attribute) release_hint_rules (generate_changelog.configuration.Configuration attribute) ReleaseRule (class in generate_changelog.release_hint)

render_changelog() (in module generate_changelog.templating) rendered_variables (generate_changelog.configuration.Configuration property) RenderedChangelog (class in generate_changelog.templating) replacement (generate_changelog.actions.text_processing.RegexSub attribute) resolve_name() (in module generate_changelog.utilities) RuleProcessor (class in generate_changelog.release_hint) run() (generate_changelog.pipeline.Action method) (generate_changelog.pipeline.Pipeline method)

S

set_config() (in module generate_changelog.configuration) SetDefault (class in generate_changelog.actions.text_processing) sha (generate_changelog.context.CommitContext attribute) short_sha (generate_changelog.context.CommitContext property) Slice (class in generate_changelog.actions.text_processing) sort_group_commits() (in module generate_changelog.commits) start (generate_changelog.actions.text_processing.Slice attribute) starting_tag_pipeline (generate_changelog.configuration.Configuration attribute)

stdout() (in module generate_changelog.actions.file_processing) step (generate_changelog.actions.text_processing.Slice attribute) stop (generate_changelog.actions.text_processing.Slice attribute) Strip (class in generate_changelog.actions.text_processing) suggest_release_type() (in module generate_changelog.release_hint) summary (generate_changelog.context.CommitContext attribute) summary_pipeline (generate_changelog.configuration.Configuration attribute) SummaryRegexMatch (class in generate_changelog.actions.matching)

T

tag (generate_changelog.context.VersionContext attribute) tag_info (generate_changelog.git_ops.GitTag attribute) tag_name (generate_changelog.git_ops.GitTag attribute) tag_pattern (generate_changelog.configuration.Configuration attribute)

tagged_datetime (generate_changelog.git_ops.TagInfo attribute) tagger (generate_changelog.context.VersionContext attribute) (generate_changelog.git_ops.TagInfo attribute) TagInfo (class in generate_changelog.git_ops) template_dirs (generate_changelog.configuration.Configuration attribute)

U

unreleased_label (generate_changelog.configuration.Configuration attribute) (generate_changelog.context.ChangelogContext attribute)

update_from_file() (generate_changelog.configuration.Configuration method)

V

valid_author_tokens (generate_changelog.configuration.Configuration attribute) (generate_changelog.context.ChangelogContext attribute) variables (generate_changelog.configuration.Configuration attribute) verbose_flag (generate_changelog.actions.text_processing.RegExCommand attribute)

version_callback() (in module generate_changelog.cli) version_metadata_func (generate_changelog.pipeline.Action attribute) VersionContext (class in generate_changelog.context) versions (generate_changelog.context.ChangelogContext attribute)

W

width (generate_changelog.actions.text_processing.WrapParagraphs attribute) WrapParagraphs (class in generate_changelog.actions.text_processing)

write_default_config() (in module generate_changelog.configuration) WriteFile (class in generate_changelog.actions.file_processing)