Skip to content

Conversation

@dido18
Copy link
Contributor

@dido18 dido18 commented Nov 21, 2025

Motivation

Add a changelog.md file to keep track of the changes with a human-friendly explanation.

Change description

Additional Notes

Reviewer checklist

  • PR addresses a single concern.
  • PR title and description are properly filled.
  • Changes will be merged in main.
  • Changes are covered by tests.
  • Logging is meaningful in case of troubleshooting.

@dido18 dido18 changed the title Add changelog,md Add changelog.md Nov 21, 2025
@dido18 dido18 marked this pull request as ready for review November 21, 2025 15:43
Copy link
Contributor

@lucarin91 lucarin91 left a comment

Choose a reason for hiding this comment

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

I think we should also include this in the .deb package.
That should be installed in /usr/share/doc/arduino-app-cli/CHANGELOG.md.gz, better if gzipped

I would also move this to the root of the folder

- Use a valid origin in `GET /v1/monitor/ws` [#41](https://github.com/arduino/arduino-app-cli/pull/41)
- Remove `Requires` from the systemd `arduino-app-cli.service` [#34](https://github.com/arduino/arduino-app-cli/pull/34)

## [0.6.5] - 2025-10-27
Copy link
Contributor

Choose a reason for hiding this comment

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

did we skip the 0.6.4?

@per1234 per1234 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 21, 2025
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

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

Is the responsibility for maintaining the file on the contributor (i.e., changelog entry must be included in the PR), or on the project maintainer/release manager (i.e., they must write the changelog at some point(s) prior to the release)?

If the former, it should be documented in the pull request guide:

https://github.com/arduino/arduino-app-cli/blob/main/docs/contributor-guide/pull-requests.md#pull-request-guide

If the latter, it should be documented in a release procedure document.

Even if the responsibility is on the contributor, the release manager will still need to change the heading from [Unreleased] as part of the release procedure, so a step is required in the release procedure document regardless.

I recommend hosting the release procedure document in this repository. The release procedure document of the Arduino IDE repository can serve as a reference:

https://github.com/arduino/arduino-ide/blob/main/docs/internal/release-procedure.md

Co-authored-by: mirkoCrobu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants