{"id":28152621,"url":"https://github.com/lando/prepare-release-action","last_synced_at":"2026-03-07T16:31:44.513Z","repository":{"id":174006454,"uuid":"650779821","full_name":"lando/prepare-release-action","owner":"lando","description":"Prepare a Lando plugin for publishing to a package registry.","archived":false,"fork":false,"pushed_at":"2025-12-06T00:14:19.000Z","size":2300,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-12-09T09:44:56.908Z","etag":null,"topics":["devops","github-actions"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/lando.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["lando","pirog"],"patreon":"devwithlando","open_collective":"devwithlando","custom":"https://lando.dev/join"}},"created_at":"2023-06-07T19:43:30.000Z","updated_at":"2025-12-06T00:14:21.000Z","dependencies_parsed_at":"2023-12-14T11:02:10.700Z","dependency_job_id":"ac49786c-3f39-4c25-9d8d-649857ae2fda","html_url":"https://github.com/lando/prepare-release-action","commit_stats":{"total_commits":84,"total_committers":6,"mean_commits":14.0,"dds":0.5833333333333333,"last_synced_commit":"317c8fcd75c3687aa45c96599aec137bebedd12a"},"previous_names":["lando/prepare-plugin-action","lando/prepare-release-action"],"tags_count":81,"template":false,"template_full_name":null,"purl":"pkg:github/lando/prepare-release-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lando%2Fprepare-release-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lando%2Fprepare-release-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lando%2Fprepare-release-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lando%2Fprepare-release-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lando","download_url":"https://codeload.github.com/lando/prepare-release-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lando%2Fprepare-release-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30221507,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T14:02:48.375Z","status":"ssl_error","status_checked_at":"2026-03-07T14:02:43.192Z","response_time":53,"last_error":"SSL_read: 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":["devops","github-actions"],"created_at":"2025-05-15T05:11:50.599Z","updated_at":"2026-03-07T16:31:44.491Z","avatar_url":"https://github.com/lando.png","language":"JavaScript","funding_links":["https://github.com/sponsors/lando","https://github.com/sponsors/pirog","https://patreon.com/devwithlando","https://opencollective.com/devwithlando","https://lando.dev/join"],"categories":[],"sub_categories":[],"readme":"# Prepare Release Action\n\nThis action allows you to automate release steps eg bump version, compile code, bundle deps and optionally push/sync those changes back to a source repo that you've fetched with [`@actions/checkout`](https://github.com/actions/checkout). It _may_ work with repos fetched in a different way but that use case is not tested or supported so YMMV.\n\nIt was orignally designed to help automate Lando Plugin deployment and has an easy-mode `lando-plugin` input, however, you should be able to use it on any javascripty project.\n\n## Inputs\n\nAll inputs are optional however if you are **NOT** triggering this action on a `release` then you will need to set `version`.\n\n| Name | Description | Default | Example |\n|---|---|---|---|\n| `version` | The version of the thing to be released. Must be a semver valid string. | `${{ github.event.release.tag_name }}` | `v3.14.0` |\n| `bundle-dependencies` | A toggle to autoset `bundleDependencies` in `package.json`. | `false` | `true` |\n| `commands` | A list of commands to run to prepare the release. | `[]` | `npm run prepare` |\n| `meta` | A list of `path=value` strings to merge into the `package.json` | `null` | `dist=thing` |\n| `root` | The location of the code being prepared for release. | `${{ github.workspace }}` | `/path/to/my/project` |\n| `sync` | A toggle to enable/disable code syncing. | `true` | `false` |\n| `sync-branch` | The target branch to use when syncing changes back to the repo. | `${{ github.event.release.target_commitish \\|\\| github.event.pull_request.head.ref \\|\\| github.ref_name }}` | `main` |\n| `sync-email` | The email to use when syncing changes back to the repo. | `github-actions@github.com` | `riker@starfleet.gov` |\n| `sync-message` | The commit message to use when syncing changes back to the repo. | `release v%s generated by @lando/prepare-release-action` | `RELEASE %s` |\n| `sync-tags` | A list of other tags to sync back to the repo. | `[]` | `v2` |\n| `sync-token` | A Personal Access Token to use for `git` sync ops. | `${{ github.token }}` | `${{ secrets.MY_PAT }}` |\n| `sync-username` | The username to use when syncing changes back to the repo. | `github-actions` | `w.t.riker` |\n| `update-files` | The files to operate on with update-files-meta and update-files-header. | `[]` | `CHANGELOG.md` |\n| `update-files-header` | A header to prepend to update-files after they've been operated on. | `[]` | `{{ ## NEW VERSION }}` |\n| `update-files-meta` | The find/replace metadata to be used when updating update-files. | `[]` | `NEW_VERSION=${{ github.event.release.tag_name }}` |\n| `version-match` | A regex to help find the latest tag. Only used when `version=dev`. | `v[0-9].*` | `[1-2].*` |\n| `lando-plugin` | A special easy-mode setting to prepare and valdiate Lando plugins. | `false` | `true` |\n\nNote that `sync` must be set to `true` for the other `sync-*` options to do anything. Also note that in `sync-message` you can use `%s` as a placeholder for the version.\n\nAlso note that `sync-username` and `sync-email` are simply for `git config` purposes and *DO NOT* map to a GitHub user. If you want to do remote git ops as a particular user then use `sync-token`.\n\nAlso also note that `bundle-dependencies` runs _after_ sync eg it will not push changes to `bundleDependencies` in your `package.json` back to your repo. It is intended to be used for packaging dependencies when publishing to a npm compatible package registry eg `npm` or `npm.pkg.github.com`.\n\nAlso note that while `update-files-meta` is expressed as `KEY=VALUE` it must be wrapped with double brackets like `{{ KEY }}` in the relevant `update-files` for it to be properly tokenized/replaced. See our [CHANGELOG.md](https://github.com/lando/prepare-release-action/blob/main/CHANGELOG.md) for an example using the below inputs:\n\n```yaml\nupdate-files: CHANGELOG.md\nupdate-files-header: |\n  ## {{ UNRELEASED_VERSION }} - [{{ UNRELEASED_DATE }}]({{ UNRELEASED_LINK }})\n\nupdate-files-meta: |\n  UNRELEASED_DATE=May 4, 3000\n  UNRELEASED_LINK=${{ github.repositoryUrl }}\n  UNRELEASED_VERSION=v${{ github.run_id }}.${{ github.run_number }}.${{ github.run_attempt}}-build.${{ github.sha }}\n```\n\n## Caveats\n\n* If your project is a shallow clone (as is the default for `@actions/checkout`) we will `--unshallow` it to a full clone in order to sync changes.\n* If you have [branch](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule) or [tag protection](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules) turned on you will need to make sure your rules allow the `sync-token` user to both write to the `sync-branch` and `sync-tags` and to allow a `--force` alteration of the repos tags.\n\n##  Usage\n\n### Basic Usage\n\n```yaml\n- name: Prepare Release\n  uses: lando/prepare-release-action@v3\n```\n\n### Advanced Usage\n\n**Lando Plugin example:**\n\n```yaml\n- name: Prepare Release\n  uses: lando/prepare-release-action@v3\n  with:\n    lando-plugin: true\n```\n\n**GitHub Action javascript action example:**\n\n```yaml\n- name: Prepare Release\n  uses: lando/prepare-release-action@v3\n  with:\n    commands: |\n      npm run prepare\n    sync-tags: v3\n```\n\n**Everything, everywhere, all at once:**\n\n```yaml\n- name: Prepare Release\n  uses: lando/prepare-release-action@v3\n  with:\n    version: v3.1.4-riker.1\n    bundle-dependencies: true\n    commands: |\n      touch riker\n      npm run prepare\n    meta: |\n      jazzman=William T. Riker\n      bosmang=Picard\n    lando-plugin: false\n    sync: true\n    sync-branch: kirk-epsilon\n    sync-email: riker@hotmale.com\n    sync-message: \"Execute evasive manuveur pattern Riker %s\"\n    sync-tags: |\n      v1\n      riker1\n      number2\n    sync-token: ${{ secrets.MY_PAT }}\n    sync-username: w.t.riker\n    update-files: CHANGELOG.md\n    update-files-header: |\n      ## {{ UNRELEASED_VERSION }} - [{{ UNRELEASED_DATE }}]({{ UNRELEASED_LINK }})\n\n    update-files-meta: |\n      UNRELEASED_DATE=May 4, 3000\n      UNRELEASED_LINK=${{ github.repositoryUrl }}\n      UNRELEASED_VERSION=v${{ github.run_id }}.${{ github.run_number }}.${{ github.run_attempt}}-build.${{ github.sha }}\n    version-match: \"v[0-2].*\"\n```\n\n## Changelog\n\nWe try to log all changes big and small in both [THE CHANGELOG](https://github.com/lando/prepare-release-action/blob/main/CHANGELOG.md) and the [release notes](https://github.com/lando/prepare-release-action/releases).\n\n## Releasing\n\nCreate a release and publish to [GitHub Actions Marketplace](https://docs.github.com/en/enterprise-cloud@latest/actions/creating-actions/publishing-actions-in-github-marketplace)\n\n## Maintainers\n\n* [@pirog](https://github.com/pirog)\n* [@reynoldsalec](https://github.com/reynoldsalec)\n\n## Contributors\n\n\u003ca href=\"https://github.com/lando/prepare-release-action/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=lando/prepare-release-action\" /\u003e\n\u003c/a\u003e\n\nMade with [contrib.rocks](https://contrib.rocks).\n\n## Other Resources\n\n* [LICENSE](/LICENSE)\n* [TERMS OF USE](https://docs.lando.dev/terms)\n* [PRIVACY POLICY](https://docs.lando.dev/privacy)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flando%2Fprepare-release-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flando%2Fprepare-release-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flando%2Fprepare-release-action/lists"}