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.

Sign up for GitHub

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

Jump to bottom

Provide a proper changelog generator, based on the current changelog Ruby script #598

Closed
yorickpeterse opened this issue Jul 22, 2023 · 3 comments
Closed

Provide a proper changelog generator, based on the current changelog Ruby script #598

yorickpeterse opened this issue Jul 22, 2023 · 3 comments
Assignees
@yorickpeterse
Labels
feature New things to add to Inko, such as a new standard library module

Comments

@yorickpeterse
Copy link
Collaborator

The script we use for generating changelogs is based on an API provided by GitLab, also written by yours truly.

This script is copy-pasted for new projects, with a slight URL change so it generates the right commit URLs (as commit SHAs aren't auto-linked outside of issues, PRs and comments).

We should provide a simple command line program that essentially does this, but in not such a messy way. We should also change the configuration format from YAML to JSON (as we already have a JSON parser), and extend it to allow specifying a GitHub project URL, which would be used for generating links where necessary.

Since this would be an official Inko project, it would probably live at inko-lang/inko-changelog or something along those lines.

This will need a command line arguments parser first (similar to #597), and we'll need a basic Git client (using the git CLI, as libgit2 isn't great to work with, and doesn't support Git trailers anyway).

Given this is specific to Inko's GitHub workflow, and because I'm not quite sure yet about the specific details on how to implement this, this isn't something we'll be accepting contributions for, as I really want to think this through carefully.
@yorickpeterse yorickpeterse added the feature New things to add to Inko, such as a new standard library module label Jul 22, 2023
@yorickpeterse
Copy link
Collaborator Author

I've started work on this in https://github.com/yorickpeterse/clogs.

@yorickpeterse yorickpeterse self-assigned this Oct 28, 2023
@yorickpeterse
Copy link
Collaborator Author

yorickpeterse commented Nov 9, 2023 •
edited
Loading

https://github.com/yorickpeterse/clogs now implements all the necessary bits and pieces. Next up is moving the following projects over:

yorickpeterse added a commit that referenced this issue Nov 9, 2023
@yorickpeterse
Use clogs for generating changelogs
b3f73c5 
This replaces the hacky Ruby changelog script with a proper solution
using https://github.com/yorickpeterse/clogs.

See #598 for more information.
@yorickpeterse
Copy link
Collaborator Author

The mentioned projects have been moved over, so this can be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yorickpeterse yorickpeterse

Labels
feature New things to add to Inko, such as a new standard library module
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@yorickpeterse