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

ci: propose an automated way to generate changelogs #50

Open
qascade opened this issue May 20, 2023 · 6 comments
Open

ci: propose an automated way to generate changelogs #50

qascade opened this issue May 20, 2023 · 6 comments
Assignees
Labels
beginner-friendly documentation Improvements or additions to documentation good first issue Good for newcomers gssoc23 level2

Comments

@qascade
Copy link
Owner

qascade commented May 20, 2023

Description

This project strictly adheres to Conventional Commits, but we haven't added any mechanism that tracks changes on a Changelog using a Version. I will give a version no per commit. I want a way that generates and modifies changelogs on a file called changelog. md before committing.
Give me a strategy through a script that takes the semantic version as input or maybe use some existing tooling such as link. Also add a CI Workflow to make sure that the changelog has been generated before the merge.

Are you raising this Issue under GSSoC'23?

Yes

@qascade qascade added documentation Improvements or additions to documentation good first issue Good for newcomers beginner-friendly labels May 20, 2023
@qascade qascade changed the title docs: propose an automated way to generate changelogs docs(ci): propose an automated way to generate changelogs May 21, 2023
@qascade qascade changed the title docs(ci): propose an automated way to generate changelogs ci: propose an automated way to generate changelogs May 21, 2023
@Adja002
Copy link

Adja002 commented May 22, 2023

Hello,

I'd like to work on this under your guidance.
#GSSoC'23

@qascade
Copy link
Owner Author

qascade commented May 22, 2023

Hey @Adja002, Thanks for volunteering for this issue. Please follow the Repo guidelines diligently. Please let me know if you have any other questions. Please name the branch ci.changelogs

@Adja002
Copy link

Adja002 commented May 23, 2023

I have been going through the resources and researching on the topic since yesterday. I will start working on it today and reach out for further questions.

@Adja002
Copy link

Adja002 commented May 24, 2023

Hey @qascade, I have gathered my research and I'd like to submit a pull request but I'm unable to create a branch as you requested. Could you guide me on that?

@qascade
Copy link
Owner Author

qascade commented May 24, 2023

@Adja002 for branch, please look at git resources I have provided on GSSoC guidelines

@Priyank-Vaidya
Copy link

Hey @qascade I think this issue has been on stale for over 3 weeks, I would like to work on the issue Under GSSOC'23

@qascade qascade assigned Priyank-Vaidya and unassigned Adja002 Jun 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginner-friendly documentation Improvements or additions to documentation good first issue Good for newcomers gssoc23 level2
Projects
None yet
Development

No branches or pull requests

3 participants