{"id":22599161,"url":"https://github.com/lee-dohm/extract-release-notes","last_synced_at":"2025-03-28T19:43:19.912Z","repository":{"id":36984064,"uuid":"193118457","full_name":"lee-dohm/extract-release-notes","owner":"lee-dohm","description":"A GitHub Action to extract release notes from pull requests","archived":false,"fork":false,"pushed_at":"2023-01-26T02:01:47.000Z","size":611,"stargazers_count":2,"open_issues_count":18,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-26T10:09:39.648Z","etag":null,"topics":["action","extract","pull-requests","release-notes"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/lee-dohm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-21T15:09:45.000Z","updated_at":"2021-03-08T05:30:28.000Z","dependencies_parsed_at":"2023-02-14T13:15:17.877Z","dependency_job_id":null,"html_url":"https://github.com/lee-dohm/extract-release-notes","commit_stats":{"total_commits":126,"total_committers":2,"mean_commits":63.0,"dds":"0.38095238095238093","last_synced_commit":"9282b4f052b7532876c1ccea36cbf62663d9fd52"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lee-dohm%2Fextract-release-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lee-dohm%2Fextract-release-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lee-dohm%2Fextract-release-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lee-dohm%2Fextract-release-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lee-dohm","download_url":"https://codeload.github.com/lee-dohm/extract-release-notes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246092373,"owners_count":20722389,"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":["action","extract","pull-requests","release-notes"],"created_at":"2024-12-08T11:08:23.808Z","updated_at":"2025-03-28T19:43:14.898Z","avatar_url":"https://github.com/lee-dohm.png","language":"TypeScript","readme":"# Extract Release Notes Action\n\nA GitHub Action that extracts release notes from pull requests.\n\n## Use\n\nRelease notes are extracted from the body of the pull request. It looks for content starting after a [Markdown header](https://spec.commonmark.org/0.29/#atx-headings) of `Release notes`, case insensitive and the trailing `s` is optional. Everything after that header is considered to be release notes content.\n\n\u003e **Please note:** The space after the one to six `#` characters _is required._\n\nExample:\n\n```markdown\nThis is the body of a pull request. Describe everything necessary to do with the PR here.\n\n## Release notes\n\n- Fixed the thingamabob\n- Tweaked the whoosywhatsis\n- Added a foozle\n```\n\nIf no release notes section is found, an error status is returned.\n\n### Inputs\n\n- `releaseNotesPath` \u0026mdash; Path to the file where you want the release notes stored when found (_default:_ `$GITHUB_WORKSPACE/__RELEASE_NOTES.md`)\n\n### Outputs\n\n- `releaseNotesPath` \u0026mdash; Path where the release notes were stored if they were found\n\n### Example\n\nValidate that a pull request contains a release notes section:\n\n```yaml\nname: Validate release notes\n\non:\n  pull_request:\n    types: [opened, reopened, synchronized, edited]\n\njobs:\n  validateReleaseNotes:\n    name: Validate release notes\n    runs-on: ubuntu-latest\n    steps:\n      - name: Extract release notes\n        uses: lee-dohm/extract-release-notes@v2\n```\n\n## License\n\n[MIT](LICENSE.md)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flee-dohm%2Fextract-release-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flee-dohm%2Fextract-release-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flee-dohm%2Fextract-release-notes/lists"}