{"id":13601221,"url":"https://github.com/PlasmoHQ/bpp","last_synced_at":"2025-04-11T03:32:37.406Z","repository":{"id":38072789,"uuid":"456766652","full_name":"PlasmoHQ/bpp","owner":"PlasmoHQ","description":"🚀 Browser Platform Publisher","archived":false,"fork":false,"pushed_at":"2025-02-12T11:05:20.000Z","size":9963,"stargazers_count":169,"open_issues_count":11,"forks_count":11,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-09T04:04:33.222Z","etag":null,"topics":["actions","browser-extension","browser-extensions","chrome-extension","chrome-extensions","continuous-deployment","continuous-integration","edge-addon","firefox-addon","json-schema","opera-addon","web-extensions"],"latest_commit_sha":null,"homepage":"","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/PlasmoHQ.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":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-08T03:20:43.000Z","updated_at":"2025-03-27T19:16:51.000Z","dependencies_parsed_at":"2024-03-07T09:29:06.750Z","dependency_job_id":"bbba6ff7-9906-4fe3-80dd-939e520cbd7b","html_url":"https://github.com/PlasmoHQ/bpp","commit_stats":{"total_commits":158,"total_committers":9,"mean_commits":"17.555555555555557","dds":0.189873417721519,"last_synced_commit":"72c6d48e0a2e1ce23926ffc93be8455169c33abe"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlasmoHQ%2Fbpp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlasmoHQ%2Fbpp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlasmoHQ%2Fbpp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlasmoHQ%2Fbpp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PlasmoHQ","download_url":"https://codeload.github.com/PlasmoHQ/bpp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248335583,"owners_count":21086622,"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":["actions","browser-extension","browser-extensions","chrome-extension","chrome-extensions","continuous-deployment","continuous-integration","edge-addon","firefox-addon","json-schema","opera-addon","web-extensions"],"created_at":"2024-08-01T18:00:58.839Z","updated_at":"2025-04-11T03:32:37.391Z","avatar_url":"https://github.com/PlasmoHQ.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://plasmo.com\"\u003e\n    \u003cimg alt=\"plasmo logo\" width=\"75%\" src=\"https://www.plasmo.com/assets/banner-black-on-white.png\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca aria-label=\"License\" href=\"./LICENSE\"\u003e\n    \u003cimg alt=\"See License\" src=\"https://img.shields.io/github/license/PlasmoHQ/bpp?style=flat-square\"/\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"Twitter\" href=\"https://www.twitter.com/plasmohq\"\u003e\n    \u003cimg alt=\"Follow PlasmoHQ on Twitter\" src=\"https://img.shields.io/twitter/follow/plasmohq?logo=twitter\"/\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"Twitch Stream\" href=\"https://www.twitch.tv/plasmohq\"\u003e\n    \u003cimg alt=\"Watch our Live DEMO every Friday\" src=\"https://img.shields.io/twitch/status/plasmohq?logo=twitch\u0026logoColor=white\"/\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"Discord\" href=\"https://www.plasmo.com/s/d\"\u003e\n    \u003cimg alt=\"Join our Discord for support and chat about our projects\" src=\"https://img.shields.io/discord/946290204443025438?logo=discord\u0026logoColor=white\"/\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"Build status\" href=\"https://github.com/PlasmoHQ/bpp/actions\"\u003e\n    \u003cimg alt=\"typescript-action status\" src=\"https://github.com/PlasmoHQ/bpp/workflows/build-test/badge.svg\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n# Browser Platform Publisher\n\nA GitHub action from [Plasmo](https://www.plasmo.com/) to publish your browser extension to every web store/add-ons marketplace. This action and its dependencies are open-sourced under the MIT license. The core modules are:\n\n- [Browser Market Submit](https://github.com/PlasmoHQ/bms)\n- [Chrome Webstore API](https://github.com/PlasmoHQ/chrome-webstore-api)\n- [Mozilla Addons API](https://github.com/PlasmoHQ/mozilla-addons-api)\n- [Edge Addons API](https://github.com/PlasmoHQ/edge-addons-api)\n\n## Usage\n\n In order to use this action, you will need to create a json file that contains the keys and optional configuration for each browser you wish to publish to.\n\nTo help you create it, we have provided a [JSON schema](https://json-schema.org/) that can be used with editors that support it, such as Visual Studio Code. This schema will provide intellisense and validation to ensure that your configuration is correct.\n\n```json\n{\n  \"$schema\": \"https://github.com/PlasmoHQ/bpp/raw/main/keys.schema.json\"\n}\n```\n\n\u003e **NOTE**: You should only specify the browsers you wish to publish to. If there are any invalid configuration, the action will fail! I.e, no empty key allowed such as `\"chrome\": {}`.\n\nEach browser option is made of the following:\n\n* Mandatory browser specific tokens (see [token guide](https://github.com/PlasmoHQ/bms/blob/main/tokens.md))\n\n* Optional parameters:\n    * `zip`: The zip file containing the extension. The manifest.json file must be in the root of the zip file.\n  \n      `{version}` can be used in the name and will be replaced by the version from your versionFile.\n\n    * `file`: An alias for the zip property.\n\n    * `verbose`: Enable verbose logging for the specific browser.\n\n    * `versionFile`: Relative path to a json file which has a version field. Defaults to package.json\n  \n    * `sourceZip`: The zip file containing the source code for Firefox submissions.\n\n    * `source` and `sourceFile`: Aliases for the `sourceZip` property.\n\n    * `notes`: [Edge Only] Provide notes for certification to the Edge Add-ons reviewers.\n\nThe final json might look like this:\n\n```json\n{\n  \"$schema\": \"https://github.com/PlasmoHQ/bpp/raw/main/keys.schema.json\",\n  \"chrome\": {\n    \"zip\": \"chromium_addon_{version}.zip\",\n    \"clientId\": \"1280623\",\n    \"clientSecret\": \"1!9us4\",\n    \"refreshToken\": \"7\u0026as$a89\",\n    \"extId\": \"akszypg\"\n  },\n  \"firefox\": {\n    \"file\": \"firefox_addon.xpi\",\n    \"sourceFile\": \"source.zip\",\n    \"extId\": \"akszypg\",\n    \"apiKey\": \"ab214c4d\",\n    \"apiSecret\": \"e%f253^gh\"\n  },\n  \"edge\": {\n    \"zip\": \"chromium_addon.zip\",\n    \"clientId\": \"aaaaaaa-aaaa-bbbb-cccc-dddddddddddd\",\n    \"apiKey\": \"ab#c4de6fg\",\n    \"productId\": \"aaaaaaa-aaaa-bbbb-cccc-dddddddddddd\",\n    \"notes\": \"This is a test submission\"\n  }\n}\n```\n\nOnce you got your json file, you will need to copy its content into a GitHub secret. You can do this by following the [instructions on creating encrypted secrets for a repository](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository). In this example, we will use the secret name `BPP_KEYS`.\n\nThen, the action can be used as follows:\n\n```yaml\nsteps:\n  - name: Browser Platform Publish\n    uses: PlasmoHQ/bpp@v3\n    with:\n      keys: ${{ secrets.BPP_KEYS }}\n```\n\n## Action Input Parameters (`with`)\nThe following parameters can be used to override the configuration in the keys file.\nSpecifying options here will **override** those in the keys file.\n```yaml\n  keys:\n    required: true\n    description: \"A JSON string containing the keys to be used for the submission process. (This should be a secret)\"\n  artifact:\n    alias: [zip, file]\n    required: false\n    description: \"The extension zip artifact to be published on all stores.\"\n  opera-file/chrome-file/firefox-file/edge-file:\n    required: false\n    description: \"The file to be published to a specific store.\"\n  source:\n    alias: [source-zip, source-file]\n    required: false\n    description: \"The extension source zip artifact for Firefox submissions.\"\n  notes:\n    alias: [edge-notes]\n    required: false\n    description: \"[Edge only] A release note cataloging changes.\"\n  verbose:\n    required: false\n    description: \"Print out more verbose logging.\"\n  version-file:\n    required: false\n    description: \"The path to a json file with a version field, default to package.json.\"\n```\n\n###  Custom input parameters example\n```yaml\nsteps:\n  - name: Browser Platform Publish\n    uses: PlasmoHQ/bpp@v3\n    with:\n      keys: ${{ secrets.BPP_KEYS }}\n      chrome-file: \"chrome/myext_chromium_${{ env.EXT_VERSION }}.zip\"\n      edge-file: \"edge/myext_edge_${{ env.EXT_VERSION }}.zip\"\n      edge-notes: \"This is a test submission\"\n      version-file: \"src/manifest.json\"\n      verbose: true\n```\n\n# Support\n\nJoin the [Discord channel](https://www.plasmo.com/s/d)!\n\n# License\n\n[MIT](./LICENSE) ⭐ [Plasmo Corp.](https://plasmo.com)\n","funding_links":[],"categories":["TypeScript","chrome-extension","Tooling"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPlasmoHQ%2Fbpp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPlasmoHQ%2Fbpp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPlasmoHQ%2Fbpp/lists"}