Giter VIP home page Giter VIP logo

changelog-template's Introduction

CHANGELOG Template

A fancy template for CHANGELOG files.

AsciiDoc

Basic Template

= 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:
: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.

changelog-template's People

Contributors

codelenny avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.