https://github.com/codelenny/changelog-template
Template for CHANGELOG files
https://github.com/codelenny/changelog-template
Last synced: 5 months ago
JSON representation
Template for CHANGELOG files
- Host: GitHub
- URL: https://github.com/codelenny/changelog-template
- Owner: CodeLenny
- Created: 2017-12-22T16:25:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-22T17:46:58.000Z (over 8 years ago)
- Last Synced: 2025-07-20T03:07:55.851Z (11 months ago)
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CHANGELOG Template
A fancy template for CHANGELOG files.
## AsciiDoc
### Basic Template
```adoc
= Changelog
:github:
// :gitlab:
:owner: CodeLenny
:project: ...
// :first-commit: [sha]
// :latest-version: ...
ifdef::github[]
:repo-url: https://github.com/{owner}/{project}
:repo-compare: {repo-url}/compare/
:repo-changelog: {repo-url}/blob/master/CHANGELOG.adoc
:compare-split: ...
endif::[]
ifdef::gitlab[]
:repo-url: https://gitlab.com/{owner}/{project}
:repo-compare: {repo-url}/compare/
:compare-split: ...
endif::[]
ifdef::latest-version[]
== link:{repo-compare}{latest-version}{compare-split}HEAD[Unreleased]
endif::[]
ifndef::latest-version[]
ifdef::first-commit[]
== link:{repo-compare}{first-commit}{compare-split}HEAD[Unreleased]
endif::[]
ifndef::first-commit[]
== Unreleased
endif::[]
endif::[]
Initial Release.
### Added
- ...
```
### First Version
- Update `:latest-version:`
- Add after `== Unreleased`:
```adoc
:version: v0.0.1
:version-date: YYYY-MM-DD
:previous-version: {first-commit}
:version-file-url: {repo-url}/tree/{version}
:version-diff-url: {repo-compare}{previous-version}{compare-split}{version}
:version-log-url: {repo-changelog}#{version}---{version-date}
== link:{version-file-url}[{version} - {version-date}]
link:{version-file-url}[Code] (link:{version-diff-url}[Diff]) | link:{version-log-url}[Changelog]
```
### Later Versions
- Update `:latest-version`
- Use template for first version, but replace `:previous-version: {first-commit}` with an actual version number.