{"id":13902563,"url":"https://github.com/crs-k/release-draft","last_synced_at":"2025-07-06T17:12:02.233Z","repository":{"id":37057196,"uuid":"447033316","full_name":"crs-k/release-draft","owner":"crs-k","description":"Creates \u0026 updates GitHub release draft, automatically generates release notes, and bumps semver compliant tags.","archived":false,"fork":false,"pushed_at":"2025-06-12T22:04:33.000Z","size":3201,"stargazers_count":7,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-12T23:22:09.524Z","etag":null,"topics":["changelog","github-actions"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/release-draft","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/crs-k.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-01-12T01:12:41.000Z","updated_at":"2025-06-12T22:03:20.000Z","dependencies_parsed_at":"2023-12-19T02:24:09.720Z","dependency_job_id":"125b7fea-3fec-403e-8e48-0df6c0aa031d","html_url":"https://github.com/crs-k/release-draft","commit_stats":{"total_commits":578,"total_committers":3,"mean_commits":"192.66666666666666","dds":0.370242214532872,"last_synced_commit":"c1b5d9e76ad440aa6d29d44a66f7117b4ed4d151"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/crs-k/release-draft","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crs-k%2Frelease-draft","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crs-k%2Frelease-draft/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crs-k%2Frelease-draft/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crs-k%2Frelease-draft/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crs-k","download_url":"https://codeload.github.com/crs-k/release-draft/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crs-k%2Frelease-draft/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263940313,"owners_count":23533012,"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","github-actions"],"created_at":"2024-08-06T22:01:12.896Z","updated_at":"2025-07-06T17:12:02.213Z","avatar_url":"https://github.com/crs-k.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/crs-k/release-draft/actions\"\u003e\u003cimg alt=\"ci status\" src=\"https://github.com/crs-k/release-draft/actions/workflows/ci.yml/badge.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/crs-k/release-draft/actions\"\u003e\u003cimg alt=\"ci status\" src=\"https://github.com/crs-k/release-draft/actions/workflows/codeql-analysis.yml/badge.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# Release Draft\n\nThis Action automatically creates and/or updates release drafts.\n* Generates \u0026 updates release notes using GitHub's Auto-generate release notes functionality. More info [here](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes).\n* Draft tag defaults to previous tag +1 patch version. See [inputs](https://github.com/crs-k/release-draft#inputs) for more info.\n* See [example workflow](https://github.com/crs-k/release-draft#example-workflow).\n\n## Usage\n\n### Pre-requisites\nCreate a workflow `.yml` file in your repository's `.github/workflows` directory. An [example workflow](#example-workflow) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).\n\n### Inputs\nInputs are defined in [`action.yml`](action.yml):\n\n| Name | Required | Description | Default |\n| ---- | -------- | ----------- | ------- |\n| `repo-token` | `Yes`| Token to use to authenticate with GitHub API. [GITHUB_TOKEN](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) suggested. | N/A |\n| `commitish` | `No` | Target of release. | Default branch |\n| `bump` | `No` | Version increase type. Options: `major`, `minor`, `patch`. | `patch`\n| `release-strategy` | `No` | See [Release Strategies](#release-strategies) for more details. | `single`\n| `publish-strategy` | `No` | See [Publish Strategies](#publish-strategies) for more details. | `manual`\n\n### Outputs\nOutputs are defined in [`action.yml`](action.yml):\n\n| Name | Description |\n| ---- | ----------- |\n| `id` | The ID of the created Release. |\n| `html_url` | The URL users can navigate to in order to view the release. |\n| `upload_url` | The URL for uploading assets to the release. |\n\n### Release Strategies\nInputs are defined in [`action.yml`](action.yml):\n\n| Name | Description |\n| ---- | ----------- |\n| `single` | Assumes one release draft is active at a time. Release drafts will be created as a general release. Example: `v1.0.0` |\n| `double` | Assumes two environments are in use. The first release draft will be flagged as a pre-release, followed by a general draft release once the pre-release is released. Example: `v1.0.0-alpha.0` followed by `v1.0.0` |\n| `triple` | Assumes three environments are in use. This is similar to `double` but will add an additional pre-release between general releases. Example: `v1.0.0-alpha.0` followed by `v1.0.0-beta.0` followed by `v1.0.0` |\n\n### Publish Strategies\nInputs are defined in [`action.yml`](action.yml):\n\n| Name | Description |\n| ---- | ----------- |\n| `manual` | Default setting. Releases are created as drafts and not published. |\n| `auto` | Draft releases will be published if no PRs are pending against `commitish`  |\n\n## Example workflow\n\n```yaml\n# .github/workflows/release-draft.yml\n\nname: Release Draft\n\non:\n  workflow_dispatch:\n  push:\n    branches:\n      - main\n  release:\n      types: [published]\n\npermissions:\n  contents: write\n\njobs:\n  release_draft:\n    runs-on: ubuntu-latest\n    steps:\n    - name: Release Draft\n      uses: crs-k/release-draft@v0.6.1\n      with:\n        repo-token: \"${{ secrets.GITHUB_TOKEN }}\"\n```\n#### Example Release Note Configuration\n\nMore info [here](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes).\n\n```yaml\n# .github/release.yml\n\nchangelog:\n  exclude:\n    labels:\n      - \"ignore for release ✂️\"\n  categories:\n  - title: ☄️ Breaking Changes\n    labels:\n      - \"breaking change ☄️\"\n  - title: 🎉 New Features \n    labels:\n      - \"enhancement 💎\"\n  - title: 🐛 Bug Fixes\n    labels:\n      - \"bug 🐛\"\n  - title: 🧰 Maintenance\n    labels: \n      - \"chore 🧹\"\n      - \"dependencies 🛠\"\n  - title: 📓 Documentation\n    labels: \n      - \"documentation 📓\"\n  - title: 🃏 Miscellaneous\n    labels:\n      - \"*\"\n```\n\n## Contributing\nContributions are welcomed. Please read the [contributing](https://github.com/crs-k/release-draft/blob/main/CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrs-k%2Frelease-draft","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrs-k%2Frelease-draft","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrs-k%2Frelease-draft/lists"}