Skip to content

Conversation

@ulysses4ever
Copy link
Collaborator

@ulysses4ever ulysses4ever commented Sep 6, 2024

I added a WIP changelog for the tool which is easier, I think: we just remove all the tiny changelog files and at 3.16 will generate and append an update for this WIP (and it becomes the final release-notes/cabal-install-3.16...md).

Some doubts I have:


Template B: This PR does not modify behaviour or interface

E.g. the PR only touches documentation or tests, does refactorings, etc.

Include the following checklist in your PR:

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

@Kleidukos
Copy link
Member

I'm not sure about deduplication: should one change touching Cabal and cabal-install be mentioned in both changelogs?

If a changelog entry mentions two packages, then both packages' changelogs have an individual entry. Ideally PRs would have 1 changelog entry per package.

Of course for packages that share the same changelog (cabal-install and cabal-install-solvers, Cabal and Cabal-syntax), the question is not relevant.

@ulysses4ever
Copy link
Collaborator Author

All right, then it is not an issue, I guess. I'll solve the whitespace problem, but in the meantime, some eyeballing of the files would be helpful

consumed by other `Hooks` clients (e.g. eventually HLS).

- Bug fix - Don't pass --coverage-for for non-dependency libs of testsuite [#10046](https://github.com/haskell/cabal/issues/10046) [#10250](https://github.com/haskell/cabal/pull/10250)
- Added `--all` and `--haddock-all` switches to `haddock-project` subcommand [#10051](https://github.com/haskell/cabal/issues/10051) [#2272](https://github.com/haskell/cabal/pull/2272)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a mistake, the pr is #10163.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Wow, great catch!

@ffaf1
Copy link
Collaborator

ffaf1 commented Sep 6, 2024

Wiki says that a PR removing the little changelog files should go separately, why is that? Why not one PR?

One PR but different commits seems ok.

@ffaf1
Copy link
Collaborator

ffaf1 commented Sep 6, 2024

For the warnings, let's summon @fgaz

Comment on lines +90 to +94
- Neutral field to add files to sdist [#8817](https://github.com/haskell/cabal/issues/8817) [#10107](https://github.com/haskell/cabal/pull/10107)

Adds the `extra-files` field to the cabal file specification. This is like
the other `extra-*` fields in that it is copied with the `sdist` command,
except there are no other semantics. Compare to:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Mhh this seems duplicated (see top-of-file).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good catch. I'm guessing it's because the changes for Cabal and Cabal-syntax get appendent. I should properly merge the sections...

Copy link
Collaborator

Choose a reason for hiding this comment

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

I am not sure they do (or they should do), once the Swedish Francesco is here we can confirm.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

it's not about changelog-d itself, it's about how we use it. The wiki says:

$ changelog-d --long --package Cabal --prlog 3.10.3.0.prlog >> Cabal.changes
$ changelog-d --long --package Cabal-syntax --prlog 3.10.3.0.prlog >> Cabal.changes

@ulysses4ever
Copy link
Collaborator Author

I made a grieve mistake by naming the branch 3.14-blah -- it falls under the protected branches that way. I'll have to redo the PR...

@ulysses4ever
Copy link
Collaborator Author

#10323 moving here

@ulysses4ever ulysses4ever deleted the 3.14-changelogs branch September 9, 2024 02:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants