# electron-publisher-alioss

**Repository Path**: panacea123/electron-publisher-alioss

## Basic Information

- **Project Name**: electron-publisher-alioss
- **Description**: No description available
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-08
- **Last Updated**: 2022-03-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# electron-publisher-alioss
 
electron-builder AliYun OSS bucket publisher 

Base beyond @FNCxPro's [electron-publisher-gcs](https://github.com/FNCxPro/electron-publisher-gcs)

## How to Use
Install `electron-publisher-alioss`
```
    npm i -D electron-publisher-alioss
```
OR
```
    yarn add -D electron-pulisher-alioss
```

Cause we can now only to pass the configuration to the publisher by using the "custom" provider([ISSUE#3261: Allow pass configuration to custom electron-publisher provider](https://github.com/electron-userland/electron-builder/issues/3261)),  so we need to create a electron-publisher-custom.js under the build-resource-folder(it should be build/ as default) , and export the alioss-publisher by ourself.

```js
    // build/electron-publisher-custom.js
    const Publisher = require('electron-publisher-alioss')
    module.exports = Publisher;
```


Next, set your publish providers as below
```jsonc
//package.json
{
  "name": "your-app-name",
  "build": {
    "appId": "your.appId",
    "compression": "normal",
    "productName": "your App",
    "win": {
      "target": "nsis"
    },
    "publish": [
        {
          "provider": "generic",
          "url": "https:///${name}/${os}/${arch}/"
        },
        {
            "provider": "custom",
            "providerName": "alioss", 
            "path": "/${name}/${os}/${arch}/${filename}",
            "bucket": "test",
            "region": "oss-region",
            "accessKeyId": "your-ali-oss-accesskeyid",
            "accessKeySecret": "your-ali-oss-accesskeysecrect",
            "resumable": true
        }
      ]
  }
}
```
**if you want to save your ali-oss bucket info in anther file, you can use localConfig**
```jsonc
//package.json
{
  "name": "your-app-name",
  "build": {
    "appId": "your.appId",
    "compression": "normal",
    "productName": "your App",
    "win": {
      "target": "nsis"
    },
    "publish": [
        {
          "provider": "generic",
          "url": "https:///${name}/${os}/${arch}/"
        },
        {
            "provider": "custom",
            "providerName": "alioss", 
            "localConfig": "~/some/where/u/want/ali-oss-config.json"
        }
      ]
  }
}
```

```jsonc
// ~/some/where/u/want/ali-oss-config.json
{
    "path": "/${name}/${os}/${arch}/${filename}",
    "bucket": "test",
    "region": "oss-region",
    "accessKeyId": "your-ali-oss-accesskeyid",
    "accessKeySecret": "your-ali-oss-accesskeysecrect",
    "resumable": true
}
```

Basic setting is done.Enjoy the publish then.

## `Configurations`

### `path`
Type: `string`  
Default: `/${name}/${os}/${arch}/${filename}`

* `name`: the app's name (from electron-builder)  
* `os`: `task.packager.platform.name`  
* `arch`: Architecture  
* `filename`: The filename of the file being uploaded

Example:
```
/${name}/${os}/${arch}/${filename}
```

### `resumable`
Type: `boolean`  
Default: `true`


### `maxResume`
Type: `number`
default: `5`


### `verbose`
Type: `boolean`  
Default: `false`