{"id":18285914,"url":"https://github.com/exodusmovement/gh-release-generator","last_synced_at":"2025-04-09T06:21:02.258Z","repository":{"id":37956598,"uuid":"484207365","full_name":"ExodusMovement/gh-release-generator","owner":"ExodusMovement","description":"GH Action to facilitate draft releases for Exodus wallet","archived":false,"fork":false,"pushed_at":"2023-04-13T16:21:56.000Z","size":275,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-02-15T00:42:03.777Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/ExodusMovement.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}},"created_at":"2022-04-21T21:16:01.000Z","updated_at":"2022-04-29T17:49:18.000Z","dependencies_parsed_at":"2023-01-17T00:01:31.119Z","dependency_job_id":null,"html_url":"https://github.com/ExodusMovement/gh-release-generator","commit_stats":{"total_commits":33,"total_committers":3,"mean_commits":11.0,"dds":0.1515151515151515,"last_synced_commit":"60295397bf5faf10b7319984b5cde95459cdd901"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExodusMovement%2Fgh-release-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExodusMovement%2Fgh-release-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExodusMovement%2Fgh-release-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExodusMovement%2Fgh-release-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ExodusMovement","download_url":"https://codeload.github.com/ExodusMovement/gh-release-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247988030,"owners_count":21029037,"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-05T13:18:10.526Z","updated_at":"2025-04-09T06:21:02.236Z","avatar_url":"https://github.com/ExodusMovement.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GH Release Generator Github Action\n\nThis archive provides a Github Action which will iterate commits from the last\nrelease until the present, and create a set of release notes based on each\ncommit message.\n\n## Expected structure of the commit message\n\nAt Exodus, we use conventional commits, so the description is expected to have a\npreamble keyword, followed by a colon \":\", then followed by a commit message.\nAlso, following the commit description will be a single keyword which will allow\nus to group the commits into releases.\n\nThe release keywords are:\n\n1. `prod`\n1. `genesis`\n1. `eden`\n1. `dev`\n\nTypically these come after the description with two blank lines before it. The\nconventional commit will then allow us to further break these down into\nsub-categories. Some examples follow:\n\n### Merged PR Commit Examples\n\n```\nfeat(nfts): adding infinite scroll pagination on NFTs collection (#12833)\n\nprod\n```\n\n```\nfeat: Use constant DEV_START_ROUTE to configure a route to redirect to in DEV (#12886)\n\ndev\n```\n\n```\ndocs: mention components demo in guide (#12884)\n\ndev\n```\n\n```\nfix: include multi-network-assets (#12878)\n\nprod\n```\n\n## Collated Release Body\n\nThe merged commits are collated and ordered by release keyword, by commit\nkeyword preamble, then by order encountered in the commit list.\n\n### Release Body Example\n\n```\n# dev\n\n## feat\n\n- Use constant DEV_START_ROUTE to configure a route to redirect to in DEV (#12886)\n- log binded action (#12883)\n\n# eden\n\n## feat\n\n- add KIN, POLIS, stSol, XCOPE, DFL, FTT, GENE, stETH to Eden (#12866)\n\n# prod\n\n## chore\n\n- eslint-plugin-simple-import-sort (#12264)\n- bump node-fetch 2.6.1 to 2.6.7 (#12490)\n\n## feat\n\n- remove dependence on backup key in info.seco (#12841)\n- hide network badge from portfolio donut (#12857)\n- add new currencies (#12829)\n- shorten assets name (#12766)\n```\n\n## Comments (Highlights)\n\nIn order to add comments that you want to keep across generations as notes, use the following:\n\n```\n\u003c!-- HIGHLIGHTS --\u003e\nNotes go here.\nAdd multiple lines!\nThe action will preserve these comments always.\n\u003c!-- END-HIGHLIGHTS --\u003e\n```\n\nEmpty highlights will be put into new draft changelogs.\n\n## How to setup up\n\nCreate a workflow file in your project under `.github/workflows/gh-release-generator.yml`. The file should look\nlike this:\n\n```yaml\nname: GH Release Generator Action\non:\n  push:\n    branches:\n      - master\nconcurrency: ci-${{ github.repository }}\njobs:\n  release_generator:\n    runs-on: ubuntu-latest\n    steps:\n      - name: GH Release Generator\n        uses: ExodusMovement/gh-release-generator@v1.0.1\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n```\n\nMake sure you use the latest version of the release generator.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexodusmovement%2Fgh-release-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexodusmovement%2Fgh-release-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexodusmovement%2Fgh-release-generator/lists"}