{"id":15762980,"url":"https://github.com/anton-yurchenko/changelog-version","last_synced_at":"2026-01-29T07:06:00.540Z","repository":{"id":184465701,"uuid":"671952568","full_name":"anton-yurchenko/changelog-version","owner":"anton-yurchenko","description":"Create new version out of an unreleased section in changelog file","archived":false,"fork":false,"pushed_at":"2024-09-07T16:10:36.000Z","size":17206,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-05T11:23:46.957Z","etag":null,"topics":["action","actions","cd","changelog","changelog-version","ci","create-changelog-version","github","github-actions","keepachangelog","release","release-changelog-version","semver","version"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/create-changelog-version","language":"Go","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/anton-yurchenko.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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}},"created_at":"2023-07-28T14:26:31.000Z","updated_at":"2024-09-07T16:10:38.000Z","dependencies_parsed_at":"2023-10-03T16:37:30.040Z","dependency_job_id":"38043d6a-8d17-4c24-9fc3-cb34fa6812ae","html_url":"https://github.com/anton-yurchenko/changelog-version","commit_stats":null,"previous_names":["anton-yurchenko/changelog-version"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anton-yurchenko%2Fchangelog-version","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anton-yurchenko%2Fchangelog-version/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anton-yurchenko%2Fchangelog-version/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anton-yurchenko%2Fchangelog-version/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anton-yurchenko","download_url":"https://codeload.github.com/anton-yurchenko/changelog-version/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229538758,"owners_count":18088899,"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":["action","actions","cd","changelog","changelog-version","ci","create-changelog-version","github","github-actions","keepachangelog","release","release-changelog-version","semver","version"],"created_at":"2024-10-04T11:23:46.066Z","updated_at":"2026-01-29T07:05:55.519Z","avatar_url":"https://github.com/anton-yurchenko.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# changelog-version\n\n[![Release](https://img.shields.io/github/v/release/anton-yurchenko/changelog-version)](https://github.com/anton-yurchenko/changelog-version/releases/latest)\n[![Code Coverage](https://codecov.io/gh/anton-yurchenko/changelog-version/branch/main/graph/badge.svg)](https://codecov.io/gh/anton-yurchenko/changelog-version)\n[![Go Report Card](https://goreportcard.com/badge/github.com/anton-yurchenko/changelog-version)](https://goreportcard.com/report/github.com/anton-yurchenko/changelog-version)\n[![Release](https://github.com/anton-yurchenko/changelog-version/actions/workflows/release.yml/badge.svg)](https://github.com/anton-yurchenko/changelog-version/actions/workflows/release.yml)\n[![Docker Pulls](https://img.shields.io/docker/pulls/antonyurchenko/changelog-version)](https://hub.docker.com/r/antonyurchenko/changelog-version)\n[![License](https://img.shields.io/github/license/anton-yurchenko/changelog-version)](LICENSE.md)\n\nA **GitHub Action** for a new version creation in the **changelog file** using an **Unreleased section**.  \n\n\u003cp align=\"center\"\u003e\u003cimg src=\"docs/images/overview.png\"\u003e\u003c/p\u003e\n\n\u003cdetails\u003e\u003csummary\u003eDemo\u003c/summary\u003e\n\n![PIC](docs/images/demo.gif)\n\n\u003c/details\u003e\n\n## Features\n\n- Parse input to match [Semantic Versioning](https://semver.org/)\n- [Keep a Changelog](https://keepachangelog.com/) Compliant\n- Supports GitHub Enterprise\n- Supports standard `v` prefix out of the box\n- Automatically retries API operations\n\n## Manual\n\n1. Add changes to the **Unreleased** section in `CHANGELOG.md` file in your feature branch. *For example:*\n\n    ```markdown\n    ## [Unreleased]\n\n    ### Added\n    - Glob pattern support\n    - Unit Tests\n    - Log version\n    \n    ### Fixed\n    - Exception on margins larger than context of changelog\n    - Nil pointer exception in 'release' package\n    \n    ### Changed\n    - Refactor JavaScript wrapper\n    ```\n\n2. Review the changes and merge Pull Request\n3. Manually start a GitHub Actions Workflow providing a desired Semantic Version (**including `v` prefix**)\n4. **Changelog-Release** will update the Changelog file, create Tags and push the changes :wink:  \n    - [*optionally*] Trigger another workflow using the newly arrived Version Tag  \n    - [*optionally*] Update other files within current workflow before `changelog-version` to commit changed files as well (useful when you need to update a version in one of the project files like `package.json`)\n\n## Configuration\n\n1. Change the workflow to be triggered manually with the required inputs:\n\n    ```yaml\n    on:\n      workflow_dispatch:\n        inputs:\n          version:\n            type: string\n            description: \"Semantic Version (X.X.X)\"\n            required: true\n    ```\n\n2. Add *Release* step to your workflow:\n\n    ```yaml\n        - name: Update Changelog\n          uses: docker://antonyurchenko/changelog-version:v1\n          env:\n            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n            VERSION: ${{ github.event.inputs.version }}\n            UPDATE_TAGS: \"true\"\n    ```\n\n3. Configure *Release* step:\n\n    | Environmental Variable  | Allowed Values    | Default Value     | Description                                |\n    |:-----------------------:|:-----------------:|:-----------------:|:------------------------------------------:|\n    | `CHANGELOG_FILE`        | `*`               | `CHANGELOG.md`    | Changelog filename                         |\n    | `UPDATE_TAGS`           | `true`/`false`    | `false`           | Update major and minor tags (`vX`, `vX.X`) |\n\n## Remarks\n\n- This action has multiple tags: `latest / v1 / v1.2 / v1.2.3`. You may lock to a certain version instead of using **latest**.  \n(*Recommended to lock against a major version, for example* `v4`)\n- Docker image is published both to [**Docker Hub**](https://hub.docker.com/r/antonyurchenko/changelog-version) and [**GitHub Packages**](https://github.com/anton-yurchenko/changelog-version/packages). If you don't want to rely on **Docker Hub** but still want to use the dockerized action, you may switch from `uses: docker://antonyurchenko/changelog-version:latest` to `uses: docker://ghcr.io/anton-yurchenko/changelog-version:latest`\n- `changelog-version` may crash when executed against a not supported changelog file format. Make sure your changelog file is compliant to one of the supported formats.\n\n## License\n\n[MIT](LICENSE.md) © 2023-present Anton Yurchenko\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanton-yurchenko%2Fchangelog-version","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanton-yurchenko%2Fchangelog-version","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanton-yurchenko%2Fchangelog-version/lists"}