https://github.com/cardinalby/webext-buildtools-chrome-webstore-upload-action

Deploy your WebExtension to Chrome Web Store
https://github.com/cardinalby/webext-buildtools-chrome-webstore-upload-action

Last synced: about 5 hours ago
JSON representation

Deploy your WebExtension to Chrome Web Store

• Host: GitHub
• URL: https://github.com/cardinalby/webext-buildtools-chrome-webstore-upload-action
• Owner: cardinalby
• License: mit
• Created: 2020-06-22T07:58:51.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-16T20:35:19.000Z (8 months ago)
• Last Synced: 2024-10-26T10:52:08.491Z (12 days ago)
• Language: TypeScript
• Size: 2.37 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Node.js CI](https://github.com/cardinalby/webext-buildtools-chrome-webstore-upload-action/workflows/build-test/badge.svg)

# Upload your WebExtension to Chrome Web Store

Performs first step of WebExtension deployment: uploads zip to Chrome Web Store.

See [publish action](https://github.com/cardinalby/webext-buildtools-chrome-webstore-publish-action) to

continue deployment.

Based on [ChromeWebstoreBuilder](https://www.npmjs.com/package/webext-buildtools-chrome-webstore-builder) 

package.

## Inputs

* `zipFilePath` **Required**


Path to packed extension (relative to repository)

You can use [webext-buildtools-pack-extension-dir-action](https://github.com/cardinalby/webext-buildtools-pack-extension-dir-action)

to pack your extension directory and provide this input from it's output

* `extensionId` **Required**


Your extension id in Chrome Web Store

* To allow action accessing to Chrome Webstore API you can choose 2 ways:

    1. Set `apiAccessToken` input directly (you can obtain it using 

    [google-api-fetch-token-action](https://github.com/cardinalby/google-api-fetch-token-action)) 

    2. Set the following inputs to let action get access token for you. Read 

    [Using the Chrome Web Store Publish API](https://developer.chrome.com/webstore/using_webstore_api), 

    [How to generate Google API keys](https://github.com/DrewML/chrome-webstore-upload/blob/master/How%20to%20generate%20Google%20API%20keys.md)

    to learn how to obtain these values.

        * `apiClientId` **Required**

        * `apiClientSecret` **Required**

        * `apiRefreshToken` **Required** 

    Don't forget to store sensitive data as secrets.

* To handle long item processing (if after upload API returns `IN_PROGRESS` state) 

optionally you can specify 2 following inputs to check until it has `SUCCESS` state:

    * `waitForUploadCheckCount`


    Checks count in case of upload finished with IN_PROGRESS status

    * `waitForUploadCheckIntervalMs`


    Checks interval in ms in case of upload finished with IN_PROGRESS status

## Outputs

* `oldVersion` Version of extension before uploading

* `newVersion` Version of extension after uploading (if was uploaded)

* `newerVersionAlreadyUploadedError` check if step failed


`true` if failed because newer extension version is already uploaded

* `sameVersionAlreadyUploadedError` check if step failed


`true` if failed because same extension version is already uploaded

* `inReviewError` check if step failed


`true` if failed because item is currently in review and upload was rejected

## Simple usage example

```yaml

uses: cardinalby/webext-buildtools-chrome-webstore-action@v1

with:

  zipFilePath: 'build/extension.zip'

  extensionId: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

  apiClientId: ${{ secrets.G_CLIENT_ID }}

  apiClientSecret: ${{ secrets.G_CLIENT_SECRET }}

  apiRefreshToken: ${{ secrets.G_REFRESH_TOKEN }}

```

## Google refresh token expiration

According to [Google's guide](https://developers.google.com/identity/protocols/oauth2#expiration), 

the refresh token might **stop working** if it has not been used for **six months**. 

To avoid that, schedule

[google-api-fetch-token-action](https://github.com/cardinalby/google-api-fetch-token-action) action 

with the same credentials.

---

If you are interested in the building the entire deployment workflow for WebExtension, 

you can read this [article](https://cardinalby.github.io/blog/post/github-actions/webext/1-introduction/).