{"id":13706600,"url":"https://github.com/StefH/GitHubReleaseNotes","last_synced_at":"2025-05-05T20:32:07.165Z","repository":{"id":48076166,"uuid":"154834412","full_name":"StefH/GitHubReleaseNotes","owner":"StefH","description":"Generate Release Notes in markdown format from GitHub projects using Oktokit and LibGit2Sharp.","archived":false,"fork":false,"pushed_at":"2025-04-24T18:20:52.000Z","size":1241,"stargazers_count":25,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-01T12:39:45.363Z","etag":null,"topics":["generate","github","libgit2sharp","markdown","notes","oktokit","release","releasenotes"],"latest_commit_sha":null,"homepage":"","language":"C#","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/StefH.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-10-26T12:53:39.000Z","updated_at":"2025-04-24T18:20:55.000Z","dependencies_parsed_at":"2024-01-09T05:00:41.810Z","dependency_job_id":"7e89d926-05cd-4aab-99ee-c3d6571bc3ab","html_url":"https://github.com/StefH/GitHubReleaseNotes","commit_stats":{"total_commits":66,"total_committers":3,"mean_commits":22.0,"dds":0.3787878787878788,"last_synced_commit":"d82bc18874a6d4084bfe97fcbc113f3bd536b97f"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefH%2FGitHubReleaseNotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefH%2FGitHubReleaseNotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefH%2FGitHubReleaseNotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefH%2FGitHubReleaseNotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StefH","download_url":"https://codeload.github.com/StefH/GitHubReleaseNotes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252571220,"owners_count":21769797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["generate","github","libgit2sharp","markdown","notes","oktokit","release","releasenotes"],"created_at":"2024-08-02T22:01:01.684Z","updated_at":"2025-05-05T20:32:07.147Z","avatar_url":"https://github.com/StefH.png","language":"C#","readme":"# GitHubReleaseNotes\nGenerate Release Notes from GitHub.\n\n## dotnet tool\n[![NuGet Badge GitHubReleaseNotes](https://img.shields.io/nuget/v/GitHubReleaseNotes)](https://www.nuget.org/packages/GitHubReleaseNotes)\n\n### Installation\n``` cmd\ndotnet tool install --global GitHubReleaseNotes\n```\n\n## WinGet\n``` cmd\nwinget install -e --id StefHeyenrath.GitHubReleaseNotes\n```\n\n## Chocolatey\n[![Chocolatey downloads](https://img.shields.io/chocolatey/dt/githubreleasenotes.svg)](https://chocolatey.org/packages/GitHubReleaseNotes)\n[![Chocolatey](https://img.shields.io/chocolatey/v/githubreleasenotes.svg)](https://chocolatey.org/packages/GitHubReleaseNotes)\n\n### Installation\n```\nchoco install GitHubReleaseNotes\n```\n\n## Usage\nGitHubReleaseNotes can be run inside a git repository.\n```\nGitHubReleaseNotes --path . --output ReleaseNotes.md --version 1.0.4.17 --language en --skip-empty-releases --exclude-labels question\n```\n\nArguments:\n- `--path`: The path from the git repository. If not supplied, the current folder is used.\n- `--output`: The location from the generated Release Notes. If not supplied, the output is written to the console.\n- `--version`: Define a custom version name for the latest release instead of the value \"next\".\n- `--language`: Provide the language (two letter according to [ISO-639-1](https://en.wikipedia.org/wiki/ISO_639-1)) which is used to format the dates. If not provided, \"en\" is used. It's also possible to use a value like \"system\", which takes the current system ui language.\n- `--skip-empty-releases`: Define this optional argument to skip writing releases which have no associated Issues or Pull Requests.\n- `--template`: Provide a custom Handlebars template instead of the default template to generate the Release Notes.\n- `--exclude-labels`: Exclude Issues and Pull Requests which have these labels set.\n- `--exclude-labels`: To exclude issues from the generated output, provide a space separated string list from label-names you want to exclude.\n- `--token`: Provide the GitHub API token as authentication for connecting to private repositories. **@**\n- `--login` and `--password`: Provide the GitHub API login and password as authentication for connecting to private repositories. **@**\n\n**@** you only can use one authentication method\n\n## Output\nThe generated Release Notes ([Markdown](https://en.wikipedia.org/wiki/Markdown) formatted) will look like:\n```\n# 1.0.4.16 (11 September 2018)\n\n - [#202](https://github.com/StefH/GitHubReleaseNotes/pull/202) - Update logic PR contributed by [StefH](https://github.com/StefH)\n - [#201](https://github.com/StefH/GitHubReleaseNotes/issues/201) - Fix issue abc\n```\n\n## Copyright\n\n### Notes\nThis project is based on [GitTools/GitReleaseNotes](https://github.com/GitTools/GitReleaseNotes).\n\n### Dependencies\n-  [Oktokit](https://github.com/octokit/octokit.net)\n-  [LibGit2Sharp](https://github.com/aarnott/libgit2sharp)\n-  [Handlebars.Net](https://github.com/rexm/Handlebars.Net)\n-  [Fody](https://github.com/Fody/Fody)\n-  [Fody.Costura](https://github.com/Fody/Costura)\n\n","funding_links":[],"categories":["C# #"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStefH%2FGitHubReleaseNotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FStefH%2FGitHubReleaseNotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStefH%2FGitHubReleaseNotes/lists"}