{"id":15654553,"url":"https://github.com/ardalanamini/auto-changelog","last_synced_at":"2026-03-12T21:32:07.712Z","repository":{"id":36980873,"uuid":"299266005","full_name":"ardalanamini/auto-changelog","owner":"ardalanamini","description":"Github Automatic Changelog action","archived":false,"fork":false,"pushed_at":"2026-02-19T13:16:19.000Z","size":9623,"stargazers_count":26,"open_issues_count":14,"forks_count":16,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-19T17:25:23.398Z","etag":null,"topics":["actions","authors","changelog","compare","contributors","github","github-actions","prerelease","release","semver","utilities"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/auto-changelog","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/ardalanamini.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-09-28T10:01:20.000Z","updated_at":"2025-09-29T09:39:19.000Z","dependencies_parsed_at":"2024-05-01T04:36:18.359Z","dependency_job_id":"c32207b1-e106-43e9-a042-e0c87d0cd0f9","html_url":"https://github.com/ardalanamini/auto-changelog","commit_stats":{"total_commits":125,"total_committers":3,"mean_commits":"41.666666666666664","dds":"0.31999999999999995","last_synced_commit":"59a206c2969329b9a687162ba2dd00c74813e469"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"purl":"pkg:github/ardalanamini/auto-changelog","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ardalanamini%2Fauto-changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ardalanamini%2Fauto-changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ardalanamini%2Fauto-changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ardalanamini%2Fauto-changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ardalanamini","download_url":"https://codeload.github.com/ardalanamini/auto-changelog/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ardalanamini%2Fauto-changelog/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30445047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-12T21:31:01.033Z","status":"ssl_error","status_checked_at":"2026-03-12T21:30:43.161Z","response_time":114,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["actions","authors","changelog","compare","contributors","github","github-actions","prerelease","release","semver","utilities"],"created_at":"2024-10-03T12:52:25.618Z","updated_at":"2026-03-12T21:32:07.684Z","avatar_url":"https://github.com/ardalanamini.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Auto Changelog\n\n[![Test](https://github.com/ardalanamini/auto-changelog/actions/workflows/test.yml/badge.svg)](https://github.com/ardalanamini/auto-changelog/actions/workflows/test.yml)\n\nAutomatic Changelog generator\n\n## Table of Content\n\n- [Usage](#usage)\n- [Inputs](#inputs)\n  - [Github Token](#github-token)\n  - [Commit Types](#commit-types)\n  - [Default Commit Type](#default-commit-type)\n  - [Release Name](#release-name)\n  - [Release Name Prefix](#release-name-prefix)\n  - [Mention Authors](#mention-authors)\n  - [Mention New Contributors](#mention-new-contributors)\n  - [Include GitHub Compare Link](#include-compare-link)\n  - [SemVer Compatibility](#semver)\n  - [Use GitHub Autolink](#use-github-autolink)\n- [Outputs](#outputs)\n  - [Changelog](#changelog)\n  - [Pre-release](#prerelease)\n  - [Release ID](#release-id)\n- [Example Usage](#example-usage)\n\n## Usage\n\nTo use this action, your commit messages have to follow the format below:\n\n```git\ntype(category): description [flag]\n```\n\n- The `type` must be one of `commit-types` input keys. In the changelog output, the value will be used.\n\n  \u003e The changelogs will be in the same order as `commit-types` input.\n\n  \u003e If the `type` doesn't match any of the provided `commit-types` input keys, The `default-commit-type` input will be\n  used instead.\n\n- The `category` is optional and can be anything of your choice.\n\n- The `flag` is optional (if provided, it must be surrounded in square brackets) and can be one of the followings:\n\n  - `ignore` (Omits the commit from the changelog)\n\n  \u003e If `flag` is not found in the list, it'll be ignored.\n\n\u003e Commit messages not matching the format mentioned above will be ignored in the `changelog` output.\n\n### Inputs\n\n#### `github-token`\n\n**(Optional)**\n\nGithub token.\n\n_Default:_\n\n```yaml\n${{ github.token }}\n```\n\n#### `commit-types`\n\n**(Optional)**\n\nCommit types.\n\n\u003e The default value is based on the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0)\n\n_Default:_\n\n```yaml\nfeat    : New Features\nfix     : Bug Fixes\nbuild   : Build System \u0026 Dependencies\nperf    : Performance Improvements\ndocs    : Documentation\ntest    : Tests\nrefactor: Refactors\nchore   : Chores\nci      : CI\nstyle   : Code Style\nrevert  : Reverts\n```\n\n#### `default-commit-type`\n\n**(Optional)**\n\nDefault commit type.\n\nThis input will be used when the commit message matches none of the defined `commit-types` input.\n\n_Default:_\n\n```yaml\nOther Changes\n```\n\n#### `release-name`\n\n**(Optional)**\n\nRelease name (version, e.g. `v1.0.0`).\n\n_Default:_\n\n```yaml\n${{ github.ref_name }}\n```\n\n#### `release-name-prefix`\n\n**(Optional)**\n\nRelease name (version) prefix.\n\n\u003e Example: For a release name such as `@actions/github/v1.0.0` it would be `@actions/github/`\n\n_Default:_\n\n```yaml\n\"\"\n```\n\n#### `mention-authors`\n\n**(Optional)**\n\nMention the author of each commit.\n\n_Default:_\n\n```yaml\ntrue\n```\n\n#### `mention-new-contributors`\n\n**(Optional)**\n\nMention new contributors at the bottom of the changelog (New Contributors).\n\n_Default:_\n\n```yaml\ntrue\n```\n\n#### `include-compare-link`\n\n**(Optional)**\n\nInclude GitHub compare at the bottom of the changelog (Full Changelog).\n\n\u003e If there is no previous tag determined it'll be ommited regardless of the provided value.\n\n_Default:_\n\n```yaml\ntrue\n```\n\n#### `include-pr-links`\n\n**(Optional)**\n\nInclude GitHub pull request links at each log if applicable.\n\n_Default:_\n\n```yaml\ntrue\n```\n\n#### `include-commit-links`\n\n**(Optional)**\n\nInclude GitHub commit links at each log.\n\n_Default:_\n\n```yaml\ntrue\n```\n\n#### `semver`\n\n**(Optional)**\n\nEnable semver based version comparison.\n\nIf enabled it'll determine whether the github ref is a valid semver string,\nit'll fail the action in case it's not.\n\nIt'll then determine whether the version is a pre-release or not,\nif it is, the previous version will be selected from any version (pre-release or not) lesser than the current ref,\nif current ref is not a pre-release,\nthe previous version will be selected only from the latest version (not pre-release) lesser than the current ref.\n\n_Default:_\n\n```yaml\ntrue\n```\n\n#### `use-github-autolink`\n\n**(Optional)**\n\nUse [GitHub Autolink](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls).\n\n_Default:_\n\n```yaml\ntrue\n```\n\n### Outputs\n\n#### `changelog`\n\nThe generated changelog.\n\n#### `prerelease`\n\nIndicates whether it's a pre-release or not.\n\n\u003e if semver is set to `true`, otherwise this output will always return `false`.\n\n#### `release-id`\n\nThe pre-release id in case of prerelease being `true`, `latest` otherwise. (e.g. `alpha`, `beta`, `rc`, `canary`)\n\n\u003e if semver is set to `true`, otherwise this output will always return `latest`.\n\n### Example Usage\n\nUsing with default inputs:\n\n```yaml\n- name: Changelog\n  uses: ardalanamini/auto-changelog@v4\n  id  : changelog\n```\n\nUsing with custom inputs:\n\n```yaml\n- uses: ardalanamini/auto-changelog@v4\n  id  : changelog\n  name: Changelog\n  with:\n    github-token            : ${{ github.token }}\n    commit-types            : |\n      feat    : New Features\n      fix     : Bug Fixes\n      build   : Build System \u0026 Dependencies\n      perf    : Performance Improvements\n      docs    : Documentation\n      test    : Tests\n      refactor: Refactors\n      chore   : Chores\n      ci      : CI\n      style   : Code Style\n      revert  : Reverts\n    default-commit-type     : Other Changes\n    release-name            : v1.0.0\n    release-name-prefix     : \"\"\n    mention-authors         : true\n    mention-new-contributors: true\n    include-compare-link    : true\n    include-pr-links        : true\n    include-commit-links    : true\n    semver                  : true\n    use-github-autolink     : true\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fardalanamini%2Fauto-changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fardalanamini%2Fauto-changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fardalanamini%2Fauto-changelog/lists"}