Skip to content

Update cardano-node changelog #6181

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aniketd
Copy link
Contributor

@aniketd aniketd commented Apr 16, 2025

Description

@jasagredo found the inconsistency that the change-log for cardano-node wasn't kept completely up-to-date and its name wasn't following the convention.

As to "why" this might be: in my under-qualified opinion, I think most likely due to an undocumented technical limitation in our automated operational infrastructure, or second-most likely due to an egregious oversight. If it is indeed the former, I expect this PR to trigger the CI action in question.

In this PR, we update the cardano-node change-log, add a link to it from the top-level change-log, and also update its reference in the respective cardano-node.cabal file.

NOTE: The markdown link checker is expected to fail, since the link will only be valid once we merge this PR

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • roundtrip tests
    • integration tests
      See Runnings tests for more details
  • Any changes are noted in the CHANGELOG.md for affected package
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • Self-reviewed the diff

Note on CI

If your PR is from a fork, the necessary CI jobs won't trigger automatically for security reasons.
You will need to get someone with write privileges. Please contact IOG node developers to do this
for you.

@aniketd aniketd force-pushed the aniketd/cardano-node-changelog branch 2 times, most recently from 58b696e to b46f529 Compare April 17, 2025 09:42
@aniketd aniketd force-pushed the aniketd/cardano-node-changelog branch from b46f529 to dd0557b Compare April 17, 2025 10:12
@aniketd aniketd marked this pull request as ready for review April 17, 2025 10:15
@aniketd aniketd requested a review from a team as a code owner April 17, 2025 10:15
@aniketd aniketd requested a review from jasagredo April 17, 2025 13:23
Copy link
Contributor

@jasagredo jasagredo left a comment

Choose a reason for hiding this comment

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

In general I think these changes are fine, but I don't know if they are exhaustive. Is it decided that we are keeping track of the changelog for cardano-node then in the file?

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.

2 participants