{"id":19680048,"url":"https://github.com/megahertz/electron-simple-publisher","last_synced_at":"2025-07-31T22:34:18.383Z","repository":{"id":57221906,"uuid":"71455886","full_name":"megahertz/electron-simple-publisher","owner":"megahertz","description":"Simple way to publish releases for electron-simple-updater","archived":false,"fork":false,"pushed_at":"2021-11-24T03:54:39.000Z","size":159,"stargazers_count":66,"open_issues_count":4,"forks_count":25,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-19T11:02:03.696Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/megahertz.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":null,"security":null,"support":null}},"created_at":"2016-10-20T11:22:31.000Z","updated_at":"2025-01-06T10:12:02.000Z","dependencies_parsed_at":"2022-08-31T08:30:30.020Z","dependency_job_id":null,"html_url":"https://github.com/megahertz/electron-simple-publisher","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/megahertz/electron-simple-publisher","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megahertz%2Felectron-simple-publisher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megahertz%2Felectron-simple-publisher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megahertz%2Felectron-simple-publisher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megahertz%2Felectron-simple-publisher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/megahertz","download_url":"https://codeload.github.com/megahertz/electron-simple-publisher/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megahertz%2Felectron-simple-publisher/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266194299,"owners_count":23890967,"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":[],"created_at":"2024-11-11T18:03:42.870Z","updated_at":"2025-07-31T22:34:18.340Z","avatar_url":"https://github.com/megahertz.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![logo](https://raw.githubusercontent.com/megahertz/electron-simple-updater/master/logo.png)\n# electron-simple-publisher\n[![Build Status](https://travis-ci.org/megahertz/electron-simple-publisher.svg?branch=master)](https://travis-ci.org/megahertz/electron-simple-publisher)\n[![npm version](https://badge.fury.io/js/electron-simple-publisher.svg)](https://badge.fury.io/js/electron-simple-publisher)\n\n\n## Description\n\nThis module makes easy to publish updates created by\n[electron-builder](https://github.com/electron-userland/electron-builder).\nNow SSH, github, ftp, Amazon S3 and local release transports are supported.\nYou can enable update feature in your application using\n[electron-simple-updater](https://github.com/megahertz/electron-simple-updater)\n\n## Installation\n\nInstall with [npm](https://npmjs.org/package/electron-simple-publisher):\n\n    npm install --save-dev electron-simple-publisher\n\n## Usage\n1. For windows build set the target value to squirrel in package.json:\n  ```\n  ...\n  \"build\": {\n    ...\n    \"win\": {\n      \"target\": \"squirrel\"\n    }\n  },\n  ...\n  ```\n\n2. Make a distributive package using electron-builder\n\n3. Set options:\n  You can specify all option through command line arguments, but it's\n  easier to store the config in publisher.js or publisher.json in the\n  project root. Here is an example for publishing through SSH:\n  ```js\n  {\n    \"transport\": {\n      \"module\": \"ssh\",\n      \"host\": \"example.com\",\n      \"username\": \"user\",\n      \"password\": \"user's password\",\n      \"remotePath\": \"/www/example.com/updates\",\n      \"remoteUrl\": \"http://example.com/updates\",\n    },\n    \"fields\": { // Additional fields which will be added to updates.json\n      \"readme\": \"The first version\"\n    },\n    // If you've already set package.json:updater.url you can skip this option:\n    \"metaFileUrl\": \"http://example.com/updates/update.json\",\n    // Builds contained these substrings will be ignored when run clean command\n    \"except\": [\n      \"prod-v0.5.0\"\n    ]\n  }\n  ```\n\n4. Run a publish command:\n\n  `$ node_modules/.bin/publish` - will publish the latest build for\n  the current platform\n\n### Command line arguments\n\n```sh\nUsage: publish [command] [options] [arguments]\n\nCommands (default is publish):\n  publish [configFile] [buildId1 Id2 …|all] Publish a new build(s).\n  replace [configFile] [buildId]            Replace the current build.\n  remove  [configFile] [buildId1 Id2 …]     Remove one or more builds.\n  clean   [configFile]                      Remove builds missed in updates.json\n    -e, --except NAME1,NAME2                NAME1,NAME2 will be preserved\n  list    [configFile]                      Show builds on a hosting.\n\nBuildId has a following format: [platform]-[arch]-[channel]-[version]\n  You can specify only a part of buildId, like linux-x64, defaults:\n    platform: process.platform\n    arch:     process.arch\n    channel:  package.json:updater.channel or prod\n    version:  package.json:version\n\nOptions:\n  configFile             File with json ext, defaults to ./publisher.js\n  -t, --transport        Selected transport\n      --transport.{name} Specify a transport option\n  -p, --path             Path to distributive files (default dist).\n  -d, --debug            Show debug information\n  -n, --noprogress       Don't show upload progress\n      --fields.{name}    Specify a field in the target updates.json file \n      --help             Show this message\n      --version          Show publisher version\n```\n\n### Transports\n\n#### [SSH](docs/ssh.md)\n\nUpload releases using SSH protocol. This transport uses\n[ssh2](https://github.com/mscdex/ssh2) internally so you can check its\ndocumentation for all transport options.\n\n#### [Github](docs/github.md)\n\nUpload updates to github releases. You can use this transport even if\nyou don't want to share your source code. For this purposes you just\nneed to create a public repository which will store your releases.\n\n#### [FTP](docs/ftp.md)\n\nUpload releases using FTP protocol. This transport uses\n[node-ftp](https://github.com/mscdex/node-ftp) internally so you can\ncheck its documentation for all transport options.\n\n#### [Amazon S3](docs/s3.md)\n\nUpload releases to S3 storage.\n\n#### [Azure Blob storage](docs/azure.md)\n\n#### [Local](docs/local.md)\n\nThis transport allows to create file structure which can be uploaded\nto a server manually.\n\n## Related\n - [electron-builder](https://github.com/electron-userland/electron-builder) -\n A complete solution to package and build an Electron app\n - [electron-simple-updater](https://github.com/megahertz/electron-simple-updater) -\n Simple way to enable update for the electron application\n\n## License\n\nLicensed under MIT.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmegahertz%2Felectron-simple-publisher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmegahertz%2Felectron-simple-publisher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmegahertz%2Felectron-simple-publisher/lists"}