{"id":16931896,"url":"https://github.com/leodido/rn2md","last_synced_at":"2025-04-11T18:33:41.047Z","repository":{"id":55010703,"uuid":"248530165","full_name":"leodido/rn2md","owner":"leodido","description":"release-note blocks to markdown","archived":false,"fork":false,"pushed_at":"2024-01-30T17:21:58.000Z","size":53,"stargazers_count":5,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T14:38:58.144Z","etag":null,"topics":["changelog","generation","generator","hacktoberfest","markdown","release-notes"],"latest_commit_sha":null,"homepage":"","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/leodido.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":"2020-03-19T14:53:55.000Z","updated_at":"2024-03-17T14:03:11.000Z","dependencies_parsed_at":"2024-01-11T05:51:54.116Z","dependency_job_id":"5c0d2521-47a9-4b2b-8d7b-dd1d70c7707b","html_url":"https://github.com/leodido/rn2md","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/leodido%2Frn2md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leodido%2Frn2md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leodido%2Frn2md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leodido%2Frn2md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leodido","download_url":"https://codeload.github.com/leodido/rn2md/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248459078,"owners_count":21107221,"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":["changelog","generation","generator","hacktoberfest","markdown","release-notes"],"created_at":"2024-10-13T20:44:57.300Z","updated_at":"2025-04-11T18:33:41.026Z","avatar_url":"https://github.com/leodido.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# release notes to markdown\n\n\u003e Generate markdown for your changelogs from release-note blocks\n\nIt expects release-note block rows to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format.\n\nThen, it extracts the `type` and creates different sections in the resulting markdown for different `type`.\n\nFor example `new: ...` and `BREAKING CHANGE: ...` release-note rows populate the \"Major Changes\" section of the markdown.\n\n## Usage\n\n```bash\nrn2md -r falcosecurity/falco -m 0.21.0\n```\n\n## Help\n\n```\n./rn2md --help\nLittle configurable CLI to generate the markdown for your changelogs from release-note blocks found into your project pull requests.\n\nUsage:\n  rn2md [flags]\n\nFlags:\n  -b, --branch string      the target branch you want to filter by the pull requests (default \"master\")\n  -h, --help               help for rn2md\n  -m, --milestone string   the milestone you want to filter by the pull requests\n  -r, --repo string        the full github repository name (org/repo)\n  -t, --token string       a GitHub personal API token to perform authenticated requests\n```\n\n## Using the github action in your repo\n\nTo automatically generate release notes markdown for your project milestone, you must just add a step to your workflow.\n\n```yaml\n  - name: rn2md\n    uses: leodido/rn2md@master\n    with:\n      # The milestone you want to filter by the pull requests. Required.\n      milestone: 0.21.0\n      # A github token needed for the github client API calls (listing repo PRs). Defaults to ${{ github.token }}\n      token: mytoken\n      # Full name for your repo. Defaults to ${{ github.repository }}\n      repo: myorg/myrepo \n      # Target branch to filter by the pull requests. Defaults to ${{ github.event.repository.default_branch }}.\n      branch: main\n      # Target file to be generated, relative to github workspace. Defaults to release_body.md\n      output: out.md\n```\n\n---\n\n[![Analytics](https://ga-beacon.appspot.com/UA-49657176-1/rn2md?flat)](https://github.com/igrigorik/ga-beacon)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleodido%2Frn2md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleodido%2Frn2md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleodido%2Frn2md/lists"}