{"id":20471580,"url":"https://github.com/backbase/fastlane-plugin-release_notes_generator","last_synced_at":"2026-06-04T12:31:06.716Z","repository":{"id":227416071,"uuid":"621757130","full_name":"Backbase/fastlane-plugin-release_notes_generator","owner":"Backbase","description":"A fastlane plugin to generate release notes","archived":false,"fork":false,"pushed_at":"2023-04-13T14:07:58.000Z","size":39,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-01T19:43:10.986Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/Backbase.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}},"created_at":"2023-03-31T10:16:35.000Z","updated_at":"2024-03-28T14:13:28.000Z","dependencies_parsed_at":"2024-03-13T08:49:29.972Z","dependency_job_id":null,"html_url":"https://github.com/Backbase/fastlane-plugin-release_notes_generator","commit_stats":null,"previous_names":["backbase/fastlane-plugin-release_notes_generator"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Backbase%2Ffastlane-plugin-release_notes_generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Backbase%2Ffastlane-plugin-release_notes_generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Backbase%2Ffastlane-plugin-release_notes_generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Backbase%2Ffastlane-plugin-release_notes_generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Backbase","download_url":"https://codeload.github.com/Backbase/fastlane-plugin-release_notes_generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242039278,"owners_count":20061923,"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-11-15T14:16:33.498Z","updated_at":"2025-03-05T13:43:05.554Z","avatar_url":"https://github.com/Backbase.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# release_notes_generator plugin\n\n[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-generate_release_notes)\n\n## Getting Started\n\nThis project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-generate_release_notes`, add it to your project by running updating your Gemfile to include this line \n\n```bash\ngem \"fastlane-plugin-generate_release_notes\", git: \"https://github.com/Backbase/fastlane-plugin-release_notes_generator\"\n```\n\nThen be sure to install the gems by running \n```bash\nbundle install\n```\n\n\n## About release_notes_generator\n\nA fastlane plugin that creates release notes following a particular format specified by the team\n\n**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.\n\n## Example\nIn your Fastfile call the `generate_release_notes` action, you can pass the the following parameters\n - `format` either `json` or `md` for json and markdown, defaults to `json`\n - `version` the version the release, this will default to `x.y.z`\n\n ```ruby\n    generate_release_notes(format: \"json\", version: \"0.2.1\")\n ```\n\n When the plugin is run successfully, for\n - `format: \"json\"` , the `RELEASE_NOTES.json` will be updated the placeholder detail as below\n\n    ```json\n    [\n      {\n        \"version\": \"X.Y.Z\",\n        \"description\": \"A short introduction to the release, whether it's a minor, major or breaking release\",\n        \"new_features\": [\n          \"List all new features here\"\n        ],\n        \"bug_fixes\": [\n          \"List all bug fixes here\"\n        ],\n        \"breaking_changes\": [\n          \"List all breaking changes here\"\n        ],\n        \"deprecations\": [\n          \"List all deprecations here\"\n        ],\n        \"migration_steps\": [\n          \"A detailed guide on how to migrate to this version from an earlier version\"\n        ],\n        \"security_advisory\": [\n          \"Any security advisories\"\n        ]\n      }\n    ]\n    ```\n  - `format: \"md\"`, the `RELEASE_NOTES.md` will be updated the placeholder detail as below\n\n    ```markdown\n    ## [vX.Y.Z]\n    A short introduction to the release, whether it's a minor, major or breaking release\n\n    ### New / Added\n    - List all new features here\n\n    ### Bug fixes\n    - List all bug fixes here\n\n    ### Breaking changes\n    - List all breaking changes here\n\n    ### Deprecations / Updates\n    - List all deprecations here\n\n    ### Migration Steps\n    - A detailed guide on how to migrate to this version from an earlier version\n    ```\n\n## Run tests for this plugin\n\nTo run both the tests, and code style validation, run\n\n```\nrake\n```\n\nTo automatically fix many of the styling issues, use\n```\nrubocop -a\n```\n\n## Issues and Feedback\n\nFor any other issues and feedback about this plugin, please submit it to this repository.\n\n## Troubleshooting\n\nIf you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.\n\n## Using _fastlane_ Plugins\n\nFor more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).\n\n## About _fastlane_\n\n_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackbase%2Ffastlane-plugin-release_notes_generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbackbase%2Ffastlane-plugin-release_notes_generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackbase%2Ffastlane-plugin-release_notes_generator/lists"}