https://github.com/liteobject/changelog-with-ai

This repo demonstrates the CHANGELOG creation with the help of LLM
https://github.com/liteobject/changelog-with-ai

ai changelog github-api openai python

Last synced: 8 days ago
JSON representation

This repo demonstrates the CHANGELOG creation with the help of LLM

• Host: GitHub
• URL: https://github.com/liteobject/changelog-with-ai
• Owner: LiteObject
• Created: 2024-03-02T04:26:28.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-07-06T01:40:54.000Z (6 months ago)
• Last Synced: 2024-11-07T22:13:12.343Z (2 months ago)
• Topics: ai, changelog, github-api, openai, python
• Language: Python
• Homepage:
• Size: 33.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Changelog with AI

The terms "Changelog" and "Release Notes" are often used interchangeably, but they can have slightly different meanings depending on the context. Here's a general distinction between the two:

## Changelog: 

A changelog is a document or record that lists the changes made to a software application or system between different versions or releases. It typically provides a chronological account of bug fixes, feature additions, improvements, and any other modifications made to the software. A changelog is usually intended for developers, testers, and technical users who want detailed information about the changes in each version of the software. It often includes technical details such as code changes, API modifications, and other relevant information.

## Release Notes: 

Release notes, on the other hand, are a concise summary or document that highlights the key changes, improvements, and new features introduced in a software release. They are typically written for end-users, customers, or stakeholders who are interested in understanding the changes that affect their experience with the software. Release notes are often less technical and more user-oriented compared to changelogs. They may include information about new functionality, known issues, resolved bugs, important instructions, and any other relevant information that users need to be aware of.

In summary, a changelog provides a detailed account of all changes made to a software application, while release notes provide a high-level summary of the most important changes and updates in a particular software release.

---

## Links:

- [Best Changelogs](https://changelog.md/links)

- [GitHub: Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)

- [GitHub REST API documentation](https://docs.github.com/en/rest?apiVersion=2022-11-28)