npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@reyco1/release-notes

v1.0.10

Published

Generates formatted release notes from Git commit logs using OpenAI's API.

Downloads

6

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

reyco1reyco1

Keywords

release notesgitopenaicliai

Readme

Release Notes Generator

GitHub license GitHub issues GitHub code size in bytes npm npm GitHub watchers

The Release Notes Generator is a command-line tool that automates the creation of professional release notes from Git commit logs. Leveraging OpenAI's powerful GPT-3.5 model, it efficiently converts raw commit data into a clean, structured format. This tool is ideal for project managers, developers, and teams looking to streamline their release documentation process.

Features

  • Automated Generation: Automatically generates release notes from Git commit logs.
  • OpenAI Integration: Uses OpenAI's GPT-3.5 to ensure the notes are concise and professionally formatted.
  • Customizable Date Range: Generate notes for specific development periods by specifying start and end dates.

Prerequisites

Before you install and use the Release Notes Generator, ensure you have the following:

  • Node.js (v14 or higher)
  • npm (v6 or higher)
  • Git installed on your machine
  • An OpenAI API key (set as an environment variable OPENAI_API_KEY)

Installation

To install the Release Notes Generator globally, run the following command:

npm install -g @reyco1/release-notes

Usage

To generate release notes, you need to provide a date range (since and until) and an output file path:

release-notes --since=YYYY-MM-DD --until=YYYY-MM-DD --output=path/to/output.md

Example

release-notes --since=2024-01-01 --until=2024-04-01 --output=./release-notes-April.md

This will fetch commits from 1st January 2024 to 1st April 2024 and save the generated release notes to release-notes-April.md.

Configuration

Ensure that your OPENAI_API_KEY is set in your environment variables to authenticate requests to OpenAI:

export OPENAI_API_KEY="your_openai_api_key_here"

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue if you have feedback, suggestions, or improvements.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any problems or have any queries about using the tool, please open an issue on GitHub.

Authors

Thank you for using or contributing to Release Notes Generator!