github-tools / github-release-notes Goto Github PK

Stop using the callback from the github-api promises and handle the response through the promise itself, same as for catching the errors.

Could be useful to have the tag name to release as an option. Default latest

The implementation would be at: (line 164)

tags.filter(function(tag, index) {
    return (index === 0 || tag.name === releaseTagName);
})

Add the option to use GHE with an --api-url option.

Suggested and submitted by @durera with #73.

Since we've introduced minimist, the code doesn't convert the options given with dashes into camelCase.

Manage the case where there are no tags in the repo.

Currently:

Getting the list of releases: ....... (0.64 secs)
0 releases found
Getting tags: .... (0.33 secs)
Tags found:
Getting the tag dates ranges: . (0.00 secs)
Creating the body blocks from releases:
Getting all closed issues: .
Task(s) stopped because of the following error:
TypeError: Cannot read property '1' of undefined

Use nyc babel and istanbul

Check and eventually fix what happen if there is only one tag.

Create an example for usage of GithubReleaseNotes as a dependency in other projects.

Allow to --cleanse, so to delete all the tags between the latest tag (the new release) and the latest release.

Since not part of dependencies, object-deep-assign is undefined.

[Error: Cannot find module 'object-assign-deep']

Update the documentation and the readme.md file according to the new features.

looking to use this inside a vagrant box, but keep getting the following error

You need to have network connectivity

see my package.json

Right now gren generates the options with a custom function. We should give this responsibility to an external package e.g. minimist

Have the body of the releases grouped by the label, in order to have something like:

Bugs:

• #456 A fix
• #789 Amother fix

Enhancements:

• #123 A lovely feature

Use a gren.json config file to extend module's config

I want to have the chance to build the release of a specific tag, e.g. --tags=0.1.0.
This would create the release notes based on the tag 0.1.0 and the previous one.

I also want to specify the range between two tags, so --tags=2.0.0,1.0.0 would create the release notes with all the issues closed between those two tags.

Apparently there is a bug which stops the script to run more than 30 releases. It might be a pagination thing coming from the APIs.

Needs further investigation.

It would be useful to include options eg.

• --Include=All
• --Include=Commits
• --Include=MergePull

to return for example merge pull request commit messages at the moment it only returns commit messages

Create a --override flag to override the latest release, if the release exists already.

Have the flag for history releases or latest (default).

If history:

• check all the release, and create the body for all of them.
• create the full changelog
• if the changelog or the release body already exist, stop.
• if the option override is true, then override both changelog and release notes

If I try to run the script on repos with one tag only, I get this error:

Task(s) stopped because of the following error:
TypeError: Cannot read property 'name' of undefined

In addition to publishing the changes for a release in GitHub, it'd be nice if the task could create a CHANGELOG file in Markdown.

Check the network before starting the task, and fail if there is no network

Would be nice to have the chance of having different type of files for configuration.

Right now only .json is allowed.

The script would look for:

• .grenrc.json
• .grenrc.yml
• .grenrc.yaml
• .grenrc.js
• .grenrc

Since the module is getting bigger and bigger, would be easier to manage it if using ES2015 classes.

After this will be implemented we can also create more unit tests to improve the stability of the module.

Give the option to:

1. List only issues that have Milestones, which I imagine would be just an option:

{
    "onlyMilestones": true
}

2. Create release notes based on milestones rather then on dates. only applicable to issues
   To achieve it we need to create a matching system between the tag name and the milestone naming convention.

{
    "dataSource": "milestones",
    "milestoneMatch": "Release {{tag_name}}"
}

3. Use the description of the milestone in the release body.
4. Consider to filter only closed milestones (?)

Make the module working from everywhere, also using bash variables using #9

Create unit tests for utils and gren functions

Would be nice to have the GIF of the task running in the readme.md file

This feature would have the advantage of avoiding a connection to GitHub.

It should be possible to specify date format other than US

Have the chance to get informations of the user and the repo from the local config, if not provided.

Problem spot by eslint.

The RegExp doesn't need the escape character for the . when inside square braces.

Would be nice to have the options listed with the description when there is the --help flag.

Use issues as default data for release notes, and add the option for using commits.

The changelog action now has some --override capacity which is not really needed.

What the changelog function should be responsible for should only be to update the current CHANGELOG.md using the existing releases.

• The --override flag should only be able to override the latest release or a specific tag range.
• Use the --tags=[] option to configure the release range too. optional
• Would the changelog action be able to create release notes or should it just be based on the existing ones?

Unless I'm mistaken it seems message is the only variable available for templating commit entries. I was hoping to put together a changelog with a format something like:

[{{sha}}]({{url}}) {{message}} - {{author.name}}

I was wondering if there's a specific reason why commitMessages() just pulls out the commit message rather retaining the commit object (or a subset of it), which can then pass through the system eventually allowing generateCommitsBody() to template on more than just the commit message? If not, is this something that could be added?

Give the opportunity to set a custom template for the issues in the options (maybe in a .grenrc file).

The reason is that I might want to output different types of information from the issue.

It could be something like:

templates: {
    issue: '{{labels}} {{text}} {{link}}'
}

Create release notes using milestones' issues rather than tag dates. (as option)

Hey guys.

I think recent changes may have broken older versions of github-release-notes

We were using 0.4.0, if I make a brand new package.json with

{
  "name": "blah",
  "version": "1.0.0",
  "devDependencies": {
    "github-release-notes": "0.4.0",
    "install": "^0.8.7",
    "npm": "^4.4.1"
  }
}

and then run npm install

It errors out with fatal: Authentication failed for 'https://github.com/alexcanessa/github.git/'

I'm guessing it's because this repo existed in the past but has since been moved to the github-tools org but older versions of github-release-notes don't know that. So; heads up that older versions are broken.

Updating to the latest version of github-release-notes fixed it for us. Don't know if you want to do anything more to mitigate this issue for other people.

Thanks for your time

Josh

Since we have now a .grenrc.js file, is possible to pass functions to the template configuration.
We can update the code so to accept a function and use it to parse the informations.

This way the user can customise the output with JavaScript (e.g. date formatting #27)

Add the chance to remove issues with one or more issues.

e.g. ignore all the wontfix issues

Installed gren, created github key, ran gren, no errors... but nothing seems to have happened?

gren --help yields nothing useful.

What exactly is the expected result of all this? README seems to miss the mark in terms of explaining what this (hopefully useful) tool does, I'm afraid.

FWIW, my console output:

kieffer@MacBook-Pro-3$ pwd
/Users/kieffer/projects/node-mime

kieffer@MacBook-Pro-3$ lsf
total 80
-rw-r--r--   1 kieffer  staff  1098 May 11 21:53 LICENSE
-rw-r--r--   1 kieffer  staff  1894 Sep 12 15:32 Mime.js
-rw-r--r--   1 kieffer  staff  5053 Sep 12 15:40 README.md
-rw-r--r--   1 kieffer  staff   150 Sep 12 15:32 cli.js
-rw-r--r--   1 kieffer  staff   114 Sep 12 15:32 index.js
-rw-r--r--   1 kieffer  staff    88 Sep 12 15:32 lite.js
drwxr-xr-x  35 kieffer  staff  1190 Sep 12 15:44 node_modules/
-rw-r--r--   1 kieffer  staff  8168 Sep 12 15:44 package-lock.json
-rw-r--r--   1 kieffer  staff   962 Sep 12 15:44 package.json
drwxr-xr-x   6 kieffer  staff   204 Sep 12 15:40 src/
drwxr-xr-x   4 kieffer  staff   136 Sep 12 15:32 types/

kieffer@MacBook-Pro-3$ gren

Release task:
===================================
Getting the list of releases: ..... (0.49 secs)
1 releases found
Getting tags: .... (0.33 secs)
Tags found: v1.4.0, v1.3.6
Getting the tag dates ranges: .... (0.34 secs)
Creating the body blocks from releases:
Getting all closed issues: ...... (0.52 secs)
13 issues found
Skipping v1.4.0 (use --override to replace it)

kieffer@MacBook-Pro-3$ lsf
total 80
-rw-r--r--   1 kieffer  staff  1098 May 11 21:53 LICENSE
-rw-r--r--   1 kieffer  staff  1894 Sep 12 15:32 Mime.js
-rw-r--r--   1 kieffer  staff  5053 Sep 12 15:40 README.md
-rw-r--r--   1 kieffer  staff   150 Sep 12 15:32 cli.js
-rw-r--r--   1 kieffer  staff   114 Sep 12 15:32 index.js
-rw-r--r--   1 kieffer  staff    88 Sep 12 15:32 lite.js
drwxr-xr-x  35 kieffer  staff  1190 Sep 12 15:44 node_modules/
-rw-r--r--   1 kieffer  staff  8168 Sep 12 15:44 package-lock.json
-rw-r--r--   1 kieffer  staff   962 Sep 12 15:44 package.json
drwxr-xr-x   6 kieffer  staff   204 Sep 12 15:40 src/
drwxr-xr-x   4 kieffer  staff   136 Sep 12 15:32 types/

kieffer@MacBook-Pro-3$

Throw the error for non-authorisation on the repo before the task runs.

The fs.readFile() fails when ran in as grunt action.

When giving all the repo information the task fails with:

[TypeError: Cannot assign to read only property '0' of [object String]]

Issue coming from #28

There is an option user.name that, if not defined, makes everything crash.
Since we're not using that option at all, we can remove it and fix the issue.

This bug comes from #28

Handle errors regarding the token.

When trying to run the changelog action on the latest release, it doesn't get the right notes body.

Pull requests have all the discussion, tagging, search, project management, and other features of issues. But often, in a gren-enabled project, I'm still forced to create a separate issue when I've already made the PR that would close it (e.g. for a previously-unreported problem) because otherwise, the release notes would be incomplete. This adds overhead to what can be a seamless GitHub workflow.

The solution: I think gren should treat merged PRs as their own, self-closing issues if they don't explicitly close any other issue.