https://github.com/cardinalby/webext-buildtools-pack-extension-dir-action

Reads manifest and packs WebExtension dir to zip
https://github.com/cardinalby/webext-buildtools-pack-extension-dir-action

Last synced: about 5 hours ago
JSON representation

Reads manifest and packs WebExtension dir to zip

• Host: GitHub
• URL: https://github.com/cardinalby/webext-buildtools-pack-extension-dir-action
• Owner: cardinalby
• License: mit
• Created: 2020-06-26T14:02:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-03T16:57:18.000Z (8 months ago)
• Last Synced: 2024-10-26T10:38:24.105Z (12 days ago)
• Language: TypeScript
• Size: 872 KB
• Stars: 3
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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

# Pack WebExtension directory to zip

The action reads WebExtension's manifest file and packs directory to zip file.

You can use it to upload as release artifact or to provide inputs for further build steps.

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/).

Based on [DirReaderBuilder](https://www.npmjs.com/package/webext-buildtools-dir-reader-mw) package.

## Inputs

* `extensionDir`

**Required** Path to WebExtension directory (relative to repository)

* `zipFilePath`

Specify to save result zip file to path (relative to repository).

* `zipGlobPattern`

Include files according to the pattern while packing crx. 

Default: `**`

* `zipIgnore`

Patterns of files which will be excluded from the zip, separated by `|`. 

Default: `*.pem|.git|*.crx`

## Outputs

* `extensionName` from extension's manifest

* `extensionVersion` from extension's manifest

* `zipFilePath` the absolute path to the result zip file

## Example usage

```yaml

uses: cardinalby/webext-buildtools-pack-extension-dir-action@v1

with:

  extensionDir: 'extension'

  zipFilePath: 'build/extension.zip'

```