Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Allow Change Log Generation with Author Emails #302

Open
nitesh-balla opened this issue Jul 7, 2023 · 0 comments
Open

[FEATURE] Allow Change Log Generation with Author Emails #302

nitesh-balla opened this issue Jul 7, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@nitesh-balla
Copy link

nitesh-balla commented Jul 7, 2023

Is your feature request related to a problem? Please describe.
When generating a change log, cog relies on author names for identification, which are treated as signatures according to the cog.toml configuration file. However, if the author names set in the local git configuration are not unique, it can lead to mapping issues in the change log. Specifically, if there are multiple signatures with the same name but different GitHub handles, it can create confusion and potential problems in the change log generation process.

Describe the solution you'd like
To improve the change log generation process, a suggestion is to use author emails instead of author names. This change ensures that each author is uniquely identified, as email addresses typically serve as unique identifiers in most systems. By using author emails as signatures in the cog.toml configuration file, the mapping process becomes more reliable and eliminates the possibility of conflicts when multiple authors share the same name but have different email addresses associated with their GitHub handles. This enhancement promotes clarity and professionalism in the change log generation workflow.

Other potential solution
To enhance the change log generation process in Cog, we propose the addition of an optional flag that allows users to generate change logs with author emails instead of author names. Here's an example of how it could work:

By default, running the command cog changelog will generate a change log with author names placed beside their respective commits.
To generate a change log with author emails, users can pass the -emails flag when running the command. For example, cog changelog -emails.
Now, an additional configuration can be added to the cog.toml settings file. This configuration will map author emails to their corresponding usernames in the change log.
This approach provides flexibility for users to choose between displaying author names or author emails in the change log, depending on their specific requirements. It helps ensure clarity and consistency in identifying authors and their associated commits.

@nitesh-balla nitesh-balla added the enhancement New feature or request label Jul 7, 2023
@nitesh-balla nitesh-balla changed the title [FEATURE] Modify changelog to have email instead of Author name as signature. [FEATURE] Allow Change Log Generation with Author Emails Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants