Skip to content

Commit

Permalink
Merge pull request #150 from edeso/remote-origin
Browse files Browse the repository at this point in the history
refine context explanation, git remote origin requirement
  • Loading branch information
tomasbjerre authored May 7, 2023
2 parents a44128f + 7e978fb commit e37028a
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This is a library that can:
- Generate a changelog, or releasenotes, from a GIT repository.
- Determine next version, based on format of commits since last release.

It is fully configurable with a [Mustache (Handlebars)](https://github.com/jknack/handlebars.java) template and [helpers](#Helpers).
It is fully configurable with a [Mustache (Handlebars)](https://github.com/jknack/handlebars.java) template filled with a [context of placeholders](#Context) and [helpers](#Helpers).

The changelog can:

Expand Down Expand Up @@ -446,15 +446,16 @@ Works just like [Java substring](<https://docs.oracle.com/javase/7/docs/api/java

## Context

The template is supplied with this context:
The template is supplied with this context of prepopulated mustache/handlebars variables:

<details><summary>Click here to show context</summary>
<p>

```
- ownerName (Derived from the clone URL, for this repo it would be "tomasbjerre")
- repoName (Derived from the clone URL, for this repo it would be "git-changelog-lib")
- urlParts (Derived from the clone URL, for this repo it would be [git-changelog-lib, tomasbjerre, [email protected]])
(ownerName, repoName, urlParts - derived from the clone URL, git remote origin MUST BE SET)
- ownerName (for this repo it would be "tomasbjerre")
- repoName (for this repo it would be "git-changelog-lib")
- urlParts (for this repo it would be [git-changelog-lib, tomasbjerre, [email protected]])
* commits
- authorName
- authorEmailAddress
Expand Down

0 comments on commit e37028a

Please sign in to comment.