{"id":19299221,"url":"https://github.com/ecraft/github_release_notes","last_synced_at":"2025-11-17T12:04:04.817Z","repository":{"id":75433075,"uuid":"53149125","full_name":"ecraft/github_release_notes","owner":"ecraft","description":"Generate end-user-facing release notes from GitHub Releases as a Markdown document","archived":false,"fork":false,"pushed_at":"2017-04-20T09:53:18.000Z","size":44,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-02-24T01:16:55.168Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ecraft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2016-03-04T16:29:04.000Z","updated_at":"2020-04-14T19:56:38.000Z","dependencies_parsed_at":"2023-06-06T11:46:09.036Z","dependency_job_id":null,"html_url":"https://github.com/ecraft/github_release_notes","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ecraft/github_release_notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecraft%2Fgithub_release_notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecraft%2Fgithub_release_notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecraft%2Fgithub_release_notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecraft%2Fgithub_release_notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ecraft","download_url":"https://codeload.github.com/ecraft/github_release_notes/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecraft%2Fgithub_release_notes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":284877005,"owners_count":27077734,"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","status":"online","status_checked_at":"2025-11-17T02:00:06.431Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-09T23:10:37.826Z","updated_at":"2025-11-17T12:04:04.798Z","avatar_url":"https://github.com/ecraft.png","language":"Ruby","readme":"[![Build Status](https://travis-ci.com/ecraft/github_release_notes.svg?token=35kCpfKGskZKKBMy5SCM\u0026branch=master)](https://travis-ci.com/ecraft/github_release_notes)\n\n# GithubReleaseNotes\n\nUse the GitHub Releases feature to author end-user-friendly release notes, and keep the developer-facing gory details elsewhere.\n\nThis tool allows you to publish a long Markdown and HTML document with your releases.\n\nThis does the exact opposite of what [github-changelog-generator](https://github.com/skywinder/github-changelog-generator) does.\n\n## Installation\n\nAdd this line to your application's Gemfile, as an ecraft-private gem:\n\n```ruby\ngroup :development do\n  gem 'github_release_notes', '\u003e= 0.2.1', source: 'https://gem.fury.io/ecraft-gems/'\nend\n```\n\nAnd then execute:\n\n    $ bundle\n\nAdd `.github_releases.json` to your `.gitignore` file:\n\n```shell\n$ git ignore .github_releases.json\n```\n\n\n## Usage\n\nYou set this up using **a GitHub token** and a **custom Rake task**.\n\n### Token\n\nAdd an environment variable `RELEASE_NOTES_GITHUB_TOKEN` with a GitHub token with `repo` access.\n\nRead more at https://github.com/skywinder/github-changelog-generator#github-token\n\n### Configuration\n\nName and configure a Rake task which suits you.\n\n```ruby\nrequire 'github_release_notes/rake_task'\n\nGithubReleaseNotes::RakeTask.new(:release_notes) do |config|\n  config.repo_slug = 'olleolleolle/github_release_notes'\n  config.skipped_release_prefixes = %w(broken012/ tst_)\n\n  config.html_output = 'release_notes.html'\n  config.markdown_output = 'release_notes.md'\n  # This data will be made available to html_full.html.erb\n  config.html_template_data = {\n    title: 'Release Notes for GitHub Release Notes',\n    copyright: 'Every year!',\n    slogan: 'You break it, you buy it!'\n  }\n  # The script will look for these two:\n  #\n  # templatefiles/release_notes_templates/html_full.html.erb\n  # templatefiles/release_notes_templates/release.md.erb\n  config.templates_path = 'templatefiles/release_notes_templates'\n  config.token = ENV['RELEASE_NOTES_GITHUB_TOKEN']\n  # The regular log is colorful, but can be overridden\n  # config.logger = Logger.new('some_output.log')\n  # config.log_level = Logger::INFO\n  config.filter_lambda = -\u003e(rs) {\n    rs.select {|r| r[:tag_name] =~ /v/ }\n  }\nend\n```\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/ecraft/github_release_notes.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecraft%2Fgithub_release_notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fecraft%2Fgithub_release_notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecraft%2Fgithub_release_notes/lists"}