https://github.com/mnao305/chrome-extension-upload

upload & publish extensions to the Chrome Web Store.
https://github.com/mnao305/chrome-extension-upload

action actions chrome-extension release upload

Last synced: 3 days ago
JSON representation

upload & publish extensions to the Chrome Web Store.

• Host: GitHub
• URL: https://github.com/mnao305/chrome-extension-upload
• Owner: mnao305
• License: mit
• Created: 2020-04-25T18:17:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-03T06:55:06.000Z (11 months ago)
• Last Synced: 2024-12-28T01:03:34.798Z (4 days ago)
• Topics: action, actions, chrome-extension, release, upload
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/chrome-extension-upload-action
• Size: 497 KB
• Stars: 103
• Watchers: 2
• Forks: 15
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# chrome-extension-upload

This Action allows you to automatically upload and publish browser extensions to the Chrome web store.

This action is a wrapper for [chrome-webstore-upload](https://github.com/fregante/chrome-webstore-upload).

## Input variables

| name          | required | description                                                                                                                                                          |

| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| file-path     | true     | The path to the zip file. ex. `dist/hoge.zip`                                                                                                                        |

| extension-id  | true     |                                                                                                                                                                      |

| client-id     | true     |                                                                                                                                                                      |

| client-secret | true     |                                                                                                                                                                      |  |

| refresh-token | true     |                                                                                                                                                                      |

| glob          | false    | If you set it to true, you can specify the file as a glob pattern.
Please note that only the first match will be uploaded.                                        |

| publish       | false    | If you set it to false, the extension will not be published. Default as true.
Use this option if you want to upload the extension but not publish it for testing. |

Want to know how to make a CLIENT ID, etc.?  

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

## Usage

Simple example:

```yaml

name: Publish

on:

  push:

    tags:

      - '*'

jobs:

  build:

    name: Publish webextension

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v1

    - uses: actions/setup-node@v1

      with:

        node-version: 20

    - name: Build

      run: |

        npm ci

        npm run build

    - name: Upload & release

      uses: mnao305/[email protected]

      with:

        file-path: dist/file.zip

        extension-id: hogefuga(extension id)

        client-id: ${{ secrets.CLIENT_ID }}

        client-secret: ${{ secrets.CLIENT_SECRET }}

        refresh-token: ${{ secrets.REFRESH_TOKEN }}

```

Example with `glob`:

```yaml

name: Publish

on:

  push:

    tags:

      - '*'

jobs:

  build:

    name: Publish webextension

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v1

    - uses: actions/setup-node@v1

      with:

        node-version: 20

    - name: Build

      run: |

        npm ci

        npm run build

    - name: Upload & release

      uses: mnao305/[email protected]

      with:

        file-path: dist/*.zip

        extension-id: hogefuga(extension id)

        client-id: ${{ secrets.CLIENT_ID }}

        client-secret: ${{ secrets.CLIENT_SECRET }}

        refresh-token: ${{ secrets.REFRESH_TOKEN }}

        glob: true

```

Example with `publish` for testing:

```yaml

name: Test

on:

  push:

    tags:

      - '*'

jobs:

  build:

    name: Publish webextension

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v1

    - uses: actions/setup-node@v1

      with:

        node-version: 20

    - name: Build

      run: |

        npm ci

        npm run build

    - name: Upload & release

      uses: mnao305/[email protected]

      with:

        file-path: dist/file.zip

        extension-id: hogefuga(extension id)

        client-id: ${{ secrets.CLIENT_ID }}

        client-secret: ${{ secrets.CLIENT_SECRET }}

        refresh-token: ${{ secrets.REFRESH_TOKEN }}

        publish: false

```

Example with `publish-target` for publishing to `trustedTesters`:

```yaml

name: Test

on:

  push:

    tags:

      - '*'

jobs:

  build:

    name: Publish webextension

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v1

    - uses: actions/setup-node@v1

      with:

        node-version: 20

    - name: Build

      run: |

        npm ci

        npm run build

    - name: Upload & release

      uses: mnao305/[email protected]

      with:

        file-path: dist/file.zip

        extension-id: hogefuga(extension id)

        client-id: ${{ secrets.CLIENT_ID }}

        client-secret: ${{ secrets.CLIENT_SECRET }}

        refresh-token: ${{ secrets.REFRESH_TOKEN }}

        publish-target: trustedTesters

```