Skip to content

Commit e37028a

Browse files
authored
Merge pull request #150 from edeso/remote-origin
refine context explanation, git remote origin requirement
2 parents a44128f + 7e978fb commit e37028a

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This is a library that can:
77
- Generate a changelog, or releasenotes, from a GIT repository.
88
- Determine next version, based on format of commits since last release.
99

10-
It is fully configurable with a [Mustache (Handlebars)](https://github.com/jknack/handlebars.java) template and [helpers](#Helpers).
10+
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).
1111

1212
The changelog can:
1313

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

447447
## Context
448448

449-
The template is supplied with this context:
449+
The template is supplied with this context of prepopulated mustache/handlebars variables:
450450

451451
<details><summary>Click here to show context</summary>
452452
<p>
453453

454454
```
455-
- ownerName (Derived from the clone URL, for this repo it would be "tomasbjerre")
456-
- repoName (Derived from the clone URL, for this repo it would be "git-changelog-lib")
457-
- urlParts (Derived from the clone URL, for this repo it would be [git-changelog-lib, tomasbjerre, git@github.com])
455+
(ownerName, repoName, urlParts - derived from the clone URL, git remote origin MUST BE SET)
456+
- ownerName (for this repo it would be "tomasbjerre")
457+
- repoName (for this repo it would be "git-changelog-lib")
458+
- urlParts (for this repo it would be [git-changelog-lib, tomasbjerre, git@github.com])
458459
* commits
459460
- authorName
460461
- authorEmailAddress

0 commit comments

Comments
 (0)