question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

~~Link commits in changelog~~ add `plugin_path` option to enable loading local plugins

See original GitHub issue

Description

Add the ability to link a changelog message to the original commit. This would greatly increase the ability to provide context around changes.

Possible Solution

Ability to add a changelog option, so when generating a changelog, it would just add links in the generated markdown for the associated commit message.

After https://github.com/commitizen-tools/commitizen/issues/396#issuecomment-878673634, we decide adding a plugin_path might be a good solution for it.

Issue Analytics

  • State:open
  • Created 2 years ago
  • Reactions:1
  • Comments:13 (12 by maintainers)

github_iconTop GitHub Comments

1reaction
woilecommented, Jul 7, 2021

As of now the changelog provides some flexibility. Extra functionality like sending slack messages, customizing what is shown in the changelog, like emojis, github links, etc are considered out of the scope of the flexibility we can provide. You could create a new custom changelog with the github commits and list it in the third party section, we have a template (which needs some love 😕)

I think the design could be improved, but we don’t have the capacity at the moment, sorry for that.

1reaction
woilecommented, Jul 1, 2021

Hello! This can be achieved using a custom hook. https://commitizen-tools.github.io/commitizen/customization.html#custom-changelog-generator You can use changelog_message_builder_hook

In the example you can see the commit author is being added to each commit, the same can be done for commits:

def changelog_message_builder_hook(self, parsed_message: dict, commit: git.GitCommit) -> dict:
        rev = commit.rev
        m = parsed_message["message"]
        parsed_message["message"] = f"{m} {rev} [{commit.rev}](github.com/project/{commit.rev})"
        return parsed_message

I don’t think it makes sense to add links, because if we add github link any other git server (gitlab, bitbucket, etc) would have to have something similar.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Kafka Mysql Connector plugin.path configuration
I'm trying out to connect mysql ...
Read more >
Plugins - semantic-release
generateNotes : Generate release notes for the commits added since the ... prepare : Create or update the changelog file in the local...
Read more >
User and Workspace Settings - Visual Studio Code
One way to customize language-specific settings is by opening the Settings editor, pressing on the filter button, and selecting the language option to...
Read more >
Changelog - Connections Business Directory
DEV: Update Composer required PHP version. DEV: Add johnpbloch/wordpress-core-installer to allow-plugins in composer.json . DEV: Update dist files.
Read more >
Configuring Strimzi (0.32.0)
You can configure your Kafka cluster to allow or decline actions executed by users ... The Kubernetes Configuration Provider plugin loads configuration data ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found