tools/doreleasenotes

[jerpelea]

Summary

Simple tool to generate the NuttX release notes

tested on Python-3.8.9

Requirements
pip install PyGithub
pip install PyInquirer
pip install tqdm

The following arguments are required for generating a release: release_version, gh_token

Inspired by https://github.com/btashton/nxutils

Impact

release notes

Testing

generated notes for last 3 releases

[nuttxpr]

[Experimental Bot, please feedback here]

While this summary provides a high-level overview, it lacks the specificity required by the NuttX PR requirements. Here's a breakdown of what's missing and how to improve it:

Summary:

• Why is this change necessary? Instead of just stating it's a tool, explain the problem it solves. Is the current release note generation process manual, error-prone, or time-consuming? Does it lack specific features this tool provides?
• What functional part of the code is being changed? Since this seems like a new tool, mention where it lives within the repository (a new directory/script?).
• How does the change exactly work? Provide a brief description of the tool's workflow. Does it scrape data from somewhere? What inputs does it take? What format are the release notes generated in?

Impact:

• Is new feature added? Yes, explicitly state this is a new tool.
• Impact on the user? Who are the intended users of this tool (developers, maintainers)? How will it change their workflow? Will it be part of the standard release process?
• Impact on build? Does this tool need to be integrated into the build system or CI/CD?
• Impact on documentation? This tool likely needs its own documentation explaining how to use it. Mention if you've added this.

Testing:

• Be specific about your testing environment: Instead of just "Python-3.8.9," specify the OS as well.
• Provide more details on the target releases: Which releases did you generate notes for? Were there any issues?
• Instead of full logs, summarize your findings: Did the generated release notes match expectations? Did the tool encounter any errors?

Additional Considerations:

• Code Style: Ensure the code adheres to NuttX's coding style guidelines.
• Error Handling: Implement robust error handling in the tool.
• User Input Validation: If the tool takes user input, validate it to prevent unexpected behavior.

In short, your PR summary needs to be more comprehensive and address all the points outlined in the NuttX requirements.

[xiaoxiang781216]

please.fix.lint.error