{"id":28516135,"url":"https://github.com/dev-build-deploy/release-me","last_synced_at":"2025-07-05T17:30:30.359Z","repository":{"id":176384810,"uuid":"655715017","full_name":"dev-build-deploy/release-me","owner":"dev-build-deploy","description":"GitHub Release Management","archived":false,"fork":false,"pushed_at":"2025-07-01T19:54:44.000Z","size":4217,"stargazers_count":4,"open_issues_count":6,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-01T20:28:29.924Z","etag":null,"topics":["conventional-commits","github-releases"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/dev-build-deploy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSES/CC-BY-3.0.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":["Kevin-de-Jong"]}},"created_at":"2023-06-19T12:58:59.000Z","updated_at":"2025-07-01T19:54:47.000Z","dependencies_parsed_at":"2024-04-09T09:28:23.055Z","dependency_job_id":"fd9cb16f-ce30-40ec-9513-b4c01d6a7163","html_url":"https://github.com/dev-build-deploy/release-me","commit_stats":null,"previous_names":["dev-build-deploy/release-me"],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/dev-build-deploy/release-me","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-build-deploy%2Frelease-me","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-build-deploy%2Frelease-me/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-build-deploy%2Frelease-me/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-build-deploy%2Frelease-me/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dev-build-deploy","download_url":"https://codeload.github.com/dev-build-deploy/release-me/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-build-deploy%2Frelease-me/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263778215,"owners_count":23509954,"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":["conventional-commits","github-releases"],"created_at":"2025-06-09T03:32:23.963Z","updated_at":"2025-07-05T17:30:30.346Z","avatar_url":"https://github.com/dev-build-deploy.png","language":"TypeScript","readme":"\u003c!--\nSPDX-FileCopyrightText: 2023 Kevin de Jong \u003cmonkaii@hotmail.com\u003e\nSPDX-License-Identifier: MIT\n--\u003e\n\n# ReleaseMe - GitHub Release Management\n\nA GitHub Action to automate release management using GitHub Releases;\n\n![Example](./docs/example.png)\n\n## Features\n\n- [Creation of GitHub Releases](#basic-usage) with automatic version increments:\n  - [Semantic Versioning](./docs/versioning-strategies.md#semantic-versioning) with [Conventional Commits]\n  - [Calendar Versioning](./docs/versioning-strategies.md#calendar-versioning) using `YYYY.0M.MICRO` format.\n- Straightforward release branching support\n- Management of [GitHub Release assets](./docs/asset-management.md)\n- [Configurable changelog](./docs/configuration.md)\n- [Accessing GitHub Release information](./docs/get-release.md)\n\n## Basic Usage\n\n```yaml\nname: GitHub Release\n\nconcurrency: deployment\n\non:\n  push:\n    branches:\n      - main\n      - release/*\n\npermissions:\n  contents: write\n\njobs:\n  release-me:\n    name: Create GitHub Release\n    runs-on: ubuntu-latest\n    steps:\n      - name: Run ReleaseMe\n        id: release\n        uses: dev-build-deploy/release-me@v0\n        with:\n          token: ${{ github.token }}\n          prefix: v                    # OPTIONAL; prefixes the version with v (e.g. v1.0.0)\n          config: .github/release.yml  # OPTIONAL; path to a Release configuration\n          versioning: semver           # OPTIONAL; either `semver` or `calver`\n          files: |                     # OPTIONAL; multiline list of local files names to upload as GitHub Release assets\n            build.log\n            dependencies.json\n          artifacts: |                 # OPTIONAL; multiline list of build artifacts to upload as GitHub Release assets\n            SBOM\n\n      - if: ${{ steps.release.outputs.created }}\n        run: echo ${{ fromJSON(steps.release.outputs.release).tag_name }}\n```\n\n## Inputs\n\n| Key | Required | Description |\n| --- | --- | --- |\n| `token` | YES | GitHub token used to access GitHub |\n| `prefix` | NO | Prefix for the version, MUST be one of `[A-Za-z0-9-.]` |\n| `config`  | NO | Path to the [Release configuration](./docs/configuration.md), defaults to `.github/release.yml` | \n| `artifacts` | NO | Multiline list of artifact names, uploaded as part of the current workflow run, to upload as a [GitHub Release asset](./docs/asset-management.md) |\n| `create-release` | NO | Create the GitHub Release, can be set to `false` to perform a dry run (i.e. determine the previous and incremented version), defaults to `true`. |\n| `draft` | NO | Create a GitHub Release in `draft` status, defaults to `false` |\n| `files` | NO | Multiline list of files (paths) to upload as a [GitHub Release asset](./docs/asset-management.md) |\n| `increment-type` | NO | Enforce a specific increment type, please refer to the [Versioning Strategies](./docs/versioning-strategies.md) for more details |\n| `release-notes` | NO | Path towards a file containing the release notes to include in the GitHub release (Markdown format recommended) |\n| `version` | NO | Version to associate with the GitHub Release, can be OPTIONALLY set to override automatic detection or the `increment-type` parameter |\n| `versioning` | NO | [Versioning strategy](#versioning-strategies) to apply. MUST be one of `semver` or `calver`. Default: `semver` |\n\n## Outputs\n\n| Key | Description |\n| --- | --- |\n| `created` | Set to `true` when a release was created, otherwise the output is not set |\n| `release` | [Release object](./src/release.ts) containing relevant information about the created release. Only set when `created` is set to `true`. |\n| `previous-version` | The version of the GitHub Release prior to the current state |\n| `incremented-version` | The incremented version as used for the GitHub Release |\n\n## Permissions\n\n| Permission | Value | Description |\n| --- | --- | --- |\n| `contents` | `write` | Required to create new GitHub Releases (and push tags) |\n\n## Contributing\n\nIf you have suggestions for how release-me could be improved, or want to report a bug, open an issue! We'd love all and any contributions.\n\nFor more, check out the [Contributing Guide](CONTRIBUTING.md).\n\n## License\n\n- [MIT](./LICENSES/MIT.txt) © 2023 Kevin de Jong \\\u003cmonkaii@hotmail.com\\\u003e\n\n[SemVer]: https://semver.org\n[Conventional Commits]: https://www.conventionalcommits.org/en/v1.0.0/\n","funding_links":["https://github.com/sponsors/Kevin-de-Jong"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdev-build-deploy%2Frelease-me","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdev-build-deploy%2Frelease-me","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdev-build-deploy%2Frelease-me/lists"}