{"id":19984081,"url":"https://github.com/revery-ui/revery-packager","last_synced_at":"2025-05-04T06:31:54.971Z","repository":{"id":42506523,"uuid":"194900670","full_name":"revery-ui/revery-packager","owner":"revery-ui","description":"Helper utility to package Revery applications into installable app bundles","archived":false,"fork":false,"pushed_at":"2023-07-12T08:13:49.000Z","size":251,"stargazers_count":38,"open_issues_count":4,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-12T13:07:29.625Z","etag":null,"topics":["esy","reason","reasonml","revery"],"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/revery-ui.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,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-07-02T16:40:57.000Z","updated_at":"2023-08-14T16:13:16.000Z","dependencies_parsed_at":"2024-02-09T13:07:16.817Z","dependency_job_id":"83e35e07-62fd-400e-a326-212e5d86c662","html_url":"https://github.com/revery-ui/revery-packager","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-packager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-packager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-packager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-packager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/revery-ui","download_url":"https://codeload.github.com/revery-ui/revery-packager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223957737,"owners_count":17231677,"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":["esy","reason","reasonml","revery"],"created_at":"2024-11-13T04:17:28.710Z","updated_at":"2024-11-13T04:17:29.171Z","avatar_url":"https://github.com/revery-ui.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# revery-packager\r\n\r\nUtility inspired by [electron-builder](https://github.com/electron-userland/electron-builder) for bundling [Revery](https://outrunlabs.com/revery) applications into installable application packages.\r\n\r\nThis is extracted out from the [Onivim 2](https://v2.onivim.io) packaging scripts, and provides a way to get redistributable executables from your Revery projects.\r\n\r\nThis packager takes care of some of the heavy lifting, like:\r\n\r\n- __Windows:__ Bringing in the proper set of runtime DLL dependencies\r\n- __OS X:__ Bundling `dylibs` and remapping `rpath`s to be relocatable\r\n- __Linux:__ Bundling `so` libs and remapping `rpath`'s to be relocatable.\r\n\r\n...but you don't have to worry about that - you can just run `revery-packager` and be good to go.\r\n\r\n## Installation\r\n\r\n```\r\nnpm install -g revery-packager`\r\n```\r\n\r\n## Usage\r\n\r\n1) Ensure your Revery project is built and up-to-date (`esy install`, `esy build`).\r\n2) Run `revery-packager` at the root of your Revery project.\r\n\r\nYou'll find the release artifacts for the current platform in the `_release` folder.\r\n\r\n\u003e __NOTE:__ Today, `revery-packager` doesn't support 'cross-platform' packaging - meaning you need to run `revery-packager` on each platform you wish to distribute builds. We recommend [Azure Devops CI](https://devops.azure.com) as a way build and get packages for all platforms - see our [revery-quick-start  pipeline](https://github.com/revery-ui/revery-quick-start/blob/master/azure-pipelines.yml) for an example.\r\n\r\n## Configuration\r\n\r\nYou can customize the behavior of the packager by adding a `revery-packager` section to your `package.json`, like:\r\n\r\n__package.json__\r\n```json\r\n  \"name\": \"revery-quick-start\",\r\n  \"version\": \"1.3.0\",\r\n  \"description\": \"Revery quickstart\",\r\n  \"license\": \"MIT\",\r\n  \"esy\": {\r\n    \"build\": \"refmterr dune build -p App\",\r\n    \"buildsInSource\": \"_build\"\r\n  },\r\n  \"revery-packager\": {\r\n    \"bundleName\": \"ExampleApp\",\r\n    \"bundleId\": \"com.example.app\",\r\n    \"displayName\": \"Revery Example App\",\r\n    \"mainExecutable\": \"App\",\r\n    \"windows\": {\r\n      \"packages\": [\"zip\"],\r\n      \"iconFile\": \"assets/icon.ico\"\r\n    },\r\n    \"darwin\": {\r\n      \"packages\": [\"tar\", \"dmg\"],\r\n      \"iconFile\": \"assets/icon.icns\"\r\n    },\r\n    \"linux\": {\r\n      \"packages\": [\"tar\", \"appimage\"]\r\n    }\r\n  },\r\n  ...\r\n```\r\n\r\nThe following properties are configurable:\r\n\r\n- __`bundleName`__ - The bundle name of the application. Used for manifests and for the filename.\r\n- __`bundleId`__ - An identifier for the application. Used as the `CFBundleIdentifier` for Mac.\r\n- __`displayName`__ - Display name of the application, used for installers, desktop entries, etc.\r\n- __`mainExecutable`__ - The entry point for the application. There should be no `.exe` suffix added.\r\n- __`packages`__ - per-platform list of packages to build:\r\n- __`dmgBackground`__ - __MAC-ONLY__ - background to use for DMG installer\r\n- __`appImageType`__ - __LINUX-ONLY__ - type to use in the desktop entry for the AppImage\r\n- __`appImageCategory`__ - __LINUX_ONLY__ - category to use for the desktop entry for the AppImage\r\n- __`iconFile`__ \r\n  - __Windows__ - an `.ico` file to use for the executable\r\n  - __Linux__ - a `.png` file to use the desktop entry\r\n  - __Mac__ - an `.icns` file to use for the app icon\r\n\r\nYou can also specify per-platform settings by using the `windows`, `darwin`, and `linux` sections - you probably want to do this for settings like `iconFile`.\r\n\r\n## Roadmap\r\n\r\n- Windows\r\n  - [ ] Code signing\r\n  - [x] `zip` package\r\n  - [ ] `exe` installer\r\n  - [ ] `msi` installer\r\n- OSX\r\n  - [ ] Code signing\r\n  - [ ] Notarization\r\n  - [x] `tar` package\r\n  - [x] `dmg` package\r\n- Linux\r\n  - [ ] GPG signature\r\n  - [x] `tar` package\r\n  - [x] `appimage` package\r\n\r\n## License\r\n\r\n[MIT License](./LICENSE)\r\n\r\nCopyright 2019 Outrun Labs, LLC\r\n\r\n\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevery-ui%2Frevery-packager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frevery-ui%2Frevery-packager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevery-ui%2Frevery-packager/lists"}