Skip to content

Commit 44847f7

Browse files
committed
chore: Add a changelog (close #118)
Also add a workflow to enforce it is updated on pull requests.
1 parent b5ba5cd commit 44847f7

2 files changed

Lines changed: 67 additions & 0 deletions

File tree

.github/workflows/changelog.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Check for Changelog entries
2+
on:
3+
pull_request:
4+
types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
5+
6+
jobs:
7+
# Enforces the update of a changelog file on every pull request
8+
changelog:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: dangoslen/changelog-enforcer@v3

CHANGELOG.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
9+
## [unreleased] - Next Date
10+
11+
### Added
12+
13+
- A CHANGELOG.md file.
14+
- Details to the SVG output.
15+
- Option to specify revset to render a subset of the graph.
16+
- Gitea merge pattern.
17+
18+
### Changed
19+
20+
- Add clippy warning for complex functions.
21+
- Code refactoring to make it easier to understand.
22+
23+
### Removed
24+
25+
- Remove pager
26+
27+
28+
## [0.7.0] - 2025-11-14
29+
30+
Last release where library is part of git-graph.
31+
32+
### Added
33+
34+
- (BREAKING) graph::get_repo, add argument skip_repo_owner_validation
35+
false gives the previous behaviour.
36+
- (BREAKING) GitGraph::new, add argument start_point to control where
37+
traversal should start.
38+
Set to None to get the previous behaviour.
39+
40+
- Lots of API docs
41+
- "trunk" as supported main branch name
42+
43+
### Changed
44+
45+
- Update git2 dependency to version 0.20
46+
47+
### Removed
48+
49+
- (BREAKING) GitGraph public fields "tags" and "branches"
50+
51+
52+
## [0.6.0] - 2024-05-24
53+
54+
### Added
55+
56+
- Reverse order option

0 commit comments

Comments
 (0)