Commit f3f5a330 authored by Robert Knight's avatar Robert Knight

fixup! - Clarify what the "tag" parameter is

parent ce2a393b
...@@ -109,10 +109,12 @@ function formatChangeList(pullRequests) { ...@@ -109,10 +109,12 @@ function formatChangeList(pullRequests) {
} }
/** /**
* Return a markdown-formatted changelog of changes since a given tag, suitable * Return a markdown-formatted changelog of changes since a given Git tag,
* for inclusion in a CHANGELOG.md file. * suitable for inclusion in a CHANGELOG.md file.
* *
* If no tag is specified, default to the most recently created tag. * If no Git tag is specified, default to the most recently created tag.
*
* Tag names are usually `vX.Y.Z` where `X.Y.Z` is the package version.
*/ */
async function changelistSinceTag(octokit, tag=getLastTag()) { async function changelistSinceTag(octokit, tag=getLastTag()) {
const org = 'hypothesis'; const org = 'hypothesis';
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment