{"id":15175636,"url":"https://github.com/ipfs-shipyard/release-please-ipfs-plugin","last_synced_at":"2026-02-24T03:03:58.650Z","repository":{"id":199903946,"uuid":"704253256","full_name":"ipfs-shipyard/release-please-ipfs-plugin","owner":"ipfs-shipyard","description":"A release-please helper plugin for IPFS repos. Initially created for IPFS-desktop","archived":false,"fork":false,"pushed_at":"2024-01-12T10:51:01.000Z","size":208,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-02-14T00:55:01.573Z","etag":null,"topics":["ci-cd","ipfs","ipfs-desktop","release-please"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@ipfs-shipyard/release-please-ipfs-plugin","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ipfs-shipyard.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"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}},"created_at":"2023-10-12T21:44:08.000Z","updated_at":"2023-10-13T00:32:29.000Z","dependencies_parsed_at":"2024-10-11T04:20:45.410Z","dependency_job_id":"639dcea8-181d-4623-b91b-0ea5590614bb","html_url":"https://github.com/ipfs-shipyard/release-please-ipfs-plugin","commit_stats":null,"previous_names":["ipfs-shipyard/release-please-ipfs-plugin"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Frelease-please-ipfs-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Frelease-please-ipfs-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Frelease-please-ipfs-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Frelease-please-ipfs-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ipfs-shipyard","download_url":"https://codeload.github.com/ipfs-shipyard/release-please-ipfs-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240139109,"owners_count":19754050,"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":["ci-cd","ipfs","ipfs-desktop","release-please"],"created_at":"2024-09-27T12:39:46.510Z","updated_at":"2025-10-26T15:11:50.338Z","avatar_url":"https://github.com/ipfs-shipyard.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @ipfs-shipyard/release-please-ipfs-plugin \u003c!-- omit in toc --\u003e\n\n[![codecov](https://img.shields.io/codecov/c/github/ipfs-shipyard/release-please-ipfs-plugin.svg?style=flat-square)](https://codecov.io/gh/ipfs-shipyard/release-please-ipfs-plugin)\n[![CI](https://img.shields.io/github/actions/workflow/status/ipfs-shipyard/release-please-ipfs-plugin/js-test-and-release.yml?branch=main\\\u0026style=flat-square)](https://github.com/ipfs-shipyard/release-please-ipfs-plugin/actions/workflows/js-test-and-release.yml?query=branch%3Amain)\n\n\u003e A release-please helper plugin for IPFS repos. Initially created for IPFS-desktop\n\n## Table of contents \u003c!-- omit in toc --\u003e\n\n- [Install](#install)\n- [Introduction](#introduction)\n  - [What it does](#what-it-does)\n- [How to use](#how-to-use)\n  - [Add to release-please config](#add-to-release-please-config)\n  - [Ensure you call the release-please binary](#ensure-you-call-the-release-please-binary)\n- [Gotchas](#gotchas)\n- [License](#license)\n- [Contribution](#contribution)\n\n## Install\n\n```console\n$ npm i @ipfs-shipyard/release-please-ipfs-plugin\n```\n\n## Introduction\n\nCreated when release-please was added to the [IPFS Desktop](https://github.com/ipfs/ipfs-desktop) repo.\n\n**NOTE:** Other examples of release-please plugins were not available when this was created, so it may not be the best example of how to write a release-please plugin. Please let us know if you find a better way!\n\n### What it does\n\nModifies the changes in the PR created by release-please in the following ways:\n\n- ipfs-desktop README.md updates - Update any text with the old-version tag to the new version, similar to \u003chttps://github.com/ipfs/ipfs-desktop/blob/56a82179bd601a0051aab84792a3ed31bc0ec557/scripts/release/updateReadme.ts\u003e\n\n## How to use\n\n### Add to release-please config\n\n```jsonc\n{\n  // ...\n  \"plugins\": [/** ... */, \"@ipfs-shipyard/release-please-ipfs-plugin\"]\n  // ...\n}\n```\n\n### Ensure you call the release-please binary\n\n**NOTE:** Simply adding to the release-please config *is not enough* to make it run. You must also call the release-please CLI with the plugin name.\n\n```bash\nrelease-please release-pr ... --plugin=@ipfs-shipyard/release-please-ipfs-plugin\n```\n\nThis is the only way I found that [a release-please plugin can actually load itself](https://github.com/googleapis/release-please/blob/71dcc7b3b2df4bb3d3e0884b3f0bfb96700cb76a/src/bin/release-please.ts#L828-L843), so it can call [`registerPlugin`](https://github.com/googleapis/release-please/blob/71dcc7b3b2df4bb3d3e0884b3f0bfb96700cb76a/src/factories/plugin-factory.ts#L140-L142), so that the inner [`pluginFactories`](https://github.com/googleapis/release-please/blob/71dcc7b3b2df4bb3d3e0884b3f0bfb96700cb76a/src/factories/plugin-factory.ts#L54) can reference it when running.\n\n## Gotchas\n\n1. I have only tested this plugin with the `release-pr` command of `release-please` so far. It may not work with, or may break, other commands.\n2. This plugin is currently focused on the needs of [IPFS Desktop](https://github.com/ipfs/ipfs-desktop) and may need to be updated to support other repos and use cases.\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / \u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e)\n- MIT ([LICENSE-MIT](LICENSE-MIT) / \u003chttp://opensource.org/licenses/MIT\u003e)\n\n## Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs-shipyard%2Frelease-please-ipfs-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fipfs-shipyard%2Frelease-please-ipfs-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs-shipyard%2Frelease-please-ipfs-plugin/lists"}