{"id":23180968,"url":"https://github.com/replicatedhq/release-notes-generator","last_synced_at":"2025-04-05T03:13:47.426Z","repository":{"id":147344505,"uuid":"469872827","full_name":"replicatedhq/release-notes-generator","owner":"replicatedhq","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-10T19:55:07.000Z","size":58,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-23T03:33:15.505Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/replicatedhq.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}},"created_at":"2022-03-14T19:15:46.000Z","updated_at":"2025-02-10T19:55:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"f8697cd0-15d8-4fad-bb87-011a7d6744c0","html_url":"https://github.com/replicatedhq/release-notes-generator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replicatedhq%2Frelease-notes-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replicatedhq%2Frelease-notes-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replicatedhq%2Frelease-notes-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replicatedhq%2Frelease-notes-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/replicatedhq","download_url":"https://codeload.github.com/replicatedhq/release-notes-generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247280270,"owners_count":20912967,"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":[],"created_at":"2024-12-18T08:13:59.384Z","updated_at":"2025-04-05T03:13:47.406Z","avatar_url":"https://github.com/replicatedhq.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Release Notes Generator\n\nTakes the diff of two releases, finds all pull requests involved, and takes out their release notes and orders them into features/improvements/bugs.\n\n### Usage\n\nAn example workflow is included at [./.github/workflows/main.yml](./.github/workflows/main.yml)\n\n```yaml\nname: Generate release notes for Replicated KOTS\non: [push]\n\njobs:\n  test_action_job:\n    runs-on: ubuntu-latest\n    name: Generate release notes\n    steps:\n    - name: Checkout\n      uses: actions/checkout@v1\n    - id: test-action\n      uses: replicatedhq/release-notes-generator@main\n      with:\n        owner-repo: replicatedhq/kots\n        base: 'v1.81.1'\n        head: 'v1.82.0'\n        title: '1.82.0'\n        description: 'Support for Kubernetes: 1.21, 1.22, 1.23, and 1.24'\n        include-pr-links: false\n        github-token: ${{ secrets.GITHUB_TOKEN }}\n    - name: Print the output\n      run: echo \"${{ steps.test-action.outputs.release-notes }}\"\n```\n\n### Inputs\n\n#### owner-repo (required)\n\nThe owner/repo of the Github repository to be used.\n\n#### base (optional)\n\nThe release tag to use as the base of the release notes diff.\n\n#### head (required)\n\nThe release tag to use as the head of the release notes diff.\n\n#### title\n\nThe release notes title.\n\n#### description\n\nDescription to be added to the release notes.\n\n#### include-pr-links\n\nInclude links back to pull requests.\n\n#### github-token\n\nGithub API token to use to avoid rate limiting.\n\n### Outputs\n\n#### release-notes\n\nThe generated release notes markdown.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freplicatedhq%2Frelease-notes-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freplicatedhq%2Frelease-notes-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freplicatedhq%2Frelease-notes-generator/lists"}