{"id":19448921,"url":"https://github.com/github-tools/grunt-github-release-notes","last_synced_at":"2026-03-03T15:01:53.527Z","repository":{"id":57255108,"uuid":"46148103","full_name":"github-tools/grunt-github-release-notes","owner":"github-tools","description":"Grunt module to publish release notes based on commits between the last two tags.","archived":false,"fork":false,"pushed_at":"2022-02-13T15:29:59.000Z","size":15,"stargazers_count":6,"open_issues_count":0,"forks_count":10,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-25T02:44:58.977Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/github-tools.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-13T21:26:37.000Z","updated_at":"2025-04-14T17:48:06.000Z","dependencies_parsed_at":"2022-09-04T13:10:12.583Z","dependency_job_id":null,"html_url":"https://github.com/github-tools/grunt-github-release-notes","commit_stats":null,"previous_names":["alexcanessa/grunt-github-release-notes"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/github-tools/grunt-github-release-notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-tools%2Fgrunt-github-release-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-tools%2Fgrunt-github-release-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-tools%2Fgrunt-github-release-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-tools%2Fgrunt-github-release-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/github-tools","download_url":"https://codeload.github.com/github-tools/grunt-github-release-notes/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github-tools%2Fgrunt-github-release-notes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30050222,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T14:38:37.398Z","status":"ssl_error","status_checked_at":"2026-03-03T14:38:06.721Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T16:29:09.685Z","updated_at":"2026-03-03T15:01:53.505Z","avatar_url":"https://github.com/github-tools.png","language":"JavaScript","readme":"# Grunt Github Release Notes\n\n[![npm version](https://badge.fury.io/js/grunt-github-release-notes.svg)](https://badge.fury.io/js/grunt-github-release-notes)\n\n\u003e Grunt module to publish release notes based on commits between two tags.\nThis module is using [github-release-notes](https://github.com/alexcanessa/github-release-notes).\n\n## Getting Started\nThis plugin requires Grunt `~0.4.5` and github-release-notes `^0.5.0`\n\n```shell\nnpm install grunt-github-release-notes --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-github-release-notes');\n```\n\n## The \"release\" task\n\nBefore you can use it, you need to set up a couple of things.\n\n### Github Informations\n\n**gren** by default looks for your local git configuration to get the repo informations. This means you can run the command directly from the git repo folder.\n\nOtherwise, you can run it from wherever and specify a different repo as target, with:\n\n```js\noptions: {\n    username: USERNAME,\n    repo: REPO_NAME\n}\n```\n\n#### Token\n\nTo work, **gren** needs a `github token` (that can be easily generated following [this link](https://help.github.com/articles/creating-an-access-token-for-command-line-use/)). _You only need \"repo\" scope._\n\nOnce generated, you can run the gren command with the token as variable:\n\n```js\noptions: {\n    token: YOUR_TOKEN_HERE\n}\n```\n\nOr you can add it to your `~/.bash_profile` or `~/.zshrc`) as follows:\n\n```shell\nexport GREN_GITHUB_TOKEN=your_token_here\n```\n\n## Options\n\nThe options are the same as [github-release-notes](https://github.com/alexcanessa/github-release-notes), in camelCase:\n\n- `tags: 0.1.0|0.2.0,0.1.0` A specific tag or the range of tags to build the release notes from.\n- `timeWrap: latest|history` The release notes you want to include in the changelog. Default: `latest` _Only applicable to the `changelog` action_\n- `changelogFilename: CHANGELOG.md` The name of the changelog file. Default: `CHANGELOG.md`\n- `dataSource: issues|commits` The informations you want to use to build release notes. Default: `issues`\n- `draft: true|false` To set the release as a draft. Default: `false`\n- `prerelease: true|false` To set the release as a prerelease. Default: `false`\n- `prefix: v` Add a prefix to the tag version `e.g. v1.0.1`. Default: `null`\n- `includeMessages: merges|commits|all` used to filter the messages added to the release notes. Default: `commits`\n- `override: true|false` Override the release notes if existing. Default: `false`\n\n### Example\n\nThe module accepts two targets: *release* and *changelog*.\n\nThe *release* task will generate the last release, while the *changelog* will add the release notes to the changelog (without committing the file);\n\n```js\ngren: {\n    release: {\n        options: {\n            prefix: 'v'\n        }\n    },\n    changelog: {\n        options: {\n            changelogFilename: 'CHANGELOG.md'\n        }\n    }\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub-tools%2Fgrunt-github-release-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithub-tools%2Fgrunt-github-release-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub-tools%2Fgrunt-github-release-notes/lists"}