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

Switch cabal-install changelog to Markdown #10849

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

PraneyaKumar
Copy link

@PraneyaKumar PraneyaKumar commented Mar 25, 2025

This PR switches plain-text changelog file to ChangeLog.md

Fix #10831

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

@ffaf1
Copy link
Collaborator

ffaf1 commented Mar 25, 2025

Thanks for the contribution

Merge branch 'master' into doc/10831-switch-changelog-to-mdfile

↑ you might prefer “rebase” to “merge” (keeps commit history cleaner)

Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks!

@ulysses4ever ulysses4ever added the squash+merge me Tell Mergify Bot to squash-merge label Mar 25, 2025
@mergify mergify bot added the ready and waiting Mergify is waiting out the cooldown period label Mar 25, 2025
@ffaf1
Copy link
Collaborator

ffaf1 commented Mar 25, 2025

@PraneyaKumar if you don’t already know about the squash+merge label (placed @ulysses4ever this time), read along.

That means the PR will be in a ready and waiting state for 48 hours and then all commits will be squashed into one and then merged.

Not doing things manually allows us some more time for people to comment/check the PR.

Copy link
Collaborator

@mpickering mpickering left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also need to modify cabal-install.cabal and the filename should be ChangeLog.md so it is consistent with the other changelogs.

@PraneyaKumar
Copy link
Author

Thanks for the contribution

Merge branch 'master' into doc/10831-switch-changelog-to-mdfile

↑ you might prefer “rebase” to “merge” (keeps commit history cleaner)

Thanks for the feedback! I'll rebase instead of merging to keep the commit history clean. Let me know if there are any other best practices I should follow.


@PraneyaKumar if you don’t already know about the squash+merge label (placed @ulysses4ever this time), read along.

That means the PR will be in a ready and waiting state for 48 hours and then all commits will be squashed into one and then merged.

Not doing things manually allows us some more time for people to comment/check the PR.

Got it, thanks for the explanation! I’ll keep that in mind for future PRs. Let me know if there's anything else I should adjust before the merge.


Also need to modify cabal-install.cabal and the filename should be ChangeLog.md so it is consistent with the other changelogs.

Thanks for pointing that out! I have done the necessary changes.

@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Mar 27, 2025
@ulysses4ever ulysses4ever changed the title Doc/10831 switch changelog to mdfile Switch cabal-install changelog to Markdown Mar 28, 2025
@ulysses4ever
Copy link
Collaborator

ulysses4ever commented Mar 28, 2025

@PraneyaKumar thanks a lot for you work here!

The file name is still incorrect: it should be ChangeLog.md but right now what you have is changeLog.md (the first letter C isn't capitalized).

@PraneyaKumar PraneyaKumar force-pushed the doc/10831-switch-changelog-to-mdfile branch from c9a43e1 to c5a6fde Compare March 29, 2025 06:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days ready and waiting Mergify is waiting out the cooldown period squash+merge me Tell Mergify Bot to squash-merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[cabal-install] please switch to changelog.md
4 participants