dopry / pecans

:chestnut: Releases/downloads server with auto-updater and GitHub as a backend

Pecans

Pecans is an Electron Release Server.

Features

• Download URLS
  • /download/latest
  • /download/latest/:os
  • /download/:version
  • /download/:version/:os
  • /download/channel/:channel
  • /download/channel/:channel/:os
• Auto-updates with Squirrel
  • For Mac using Squirrel.Mac /update?version=<x.x.x>&platform=osx
    • /update/:platform/:version /update/channel/:channel/:platform/:version
  • For Windows using Squirrel.Windows and Nugets packages
    • /update/:platform/:version/RELEASES
    • /update/channel/:channel/:platform/:version/RELEASES
• GitHub Release Integration
• GitHub Private Repository Hosted Releases
• GitHub Release Webhook to keep releases up-to-date.
• Release Channels (beta, alpha, ...)
• Express App (composable)
• Release Noted API, /notes/:version
• Atom/RSS feeds for versions/channels

Deploy it / Start it

Follow our guide to deploy Pecans.

Auto-updater / Squirrel

This server provides an endpoint for Squirrel auto-updater, it supports both OS X and Windows.

Documentation

Check out the documentation for more details.

Acknowledgements

• forked from Nuts.

pecans's Issues

TypeError: backend.releases is not a function

I am using something like:

const Pecans = require("@dopry/pecans").Pecans;
const pecans = new Pecans(config.updates);
app.use('/updates', pecans.router);

And I am getting:

this.releasesCache[this.getCacheKey()] = backend.releases();   
                                                         ^
TypeError: backend.releases is not a function
    at new Pecans

I am not too familiar with TypeScript to debug it further but it is causing Pecans to not work completely. My config.updates is valid and works with Nuts. Can I have some assistance in resolving this issue? Thanks.

E2E tests

Write a suite of tests that just call the http endpoints for a known project with various architectures/versions and verify correct results.

• Use Pecans as the test GH project.
• cover platforms: win, linux, osx
• cover architectures: x86, x64, arm64, and universal

"Version" examples in README.md don't appear to work

I can't get these examples to work:

  - `/download/:version`
  - `/download/:version/:os`

It looks like we need integration tests for this (and several others).

Need better documentation of URL formats and options

In particular the tag query argument needs documentation (in api.md file):

GET http://download.myapp.com/api/resolve?platform=osx&channel=alpha&tag=2.0.1