miraclx/freyr-js

Release precompiled binaries for every platform

Open

#149 opened on Feb 21, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (2,279 stars) (154 forks)user submission
enhancementhelp wanted

Description

#121 introduces CI automation for NPM and Docker Hub publishing, #148 automates GitHub releases.

We should consider using a solution like https://github.com/vercel/pkg to package freyr into a single executable, self-contained with all dependencies, built for all platforms and served straight from the releases page.

The issues with this is as follows;

  • Having to update youtube-dl periodically.
  • Having to update the Apple Music API token periodically.

However, solutions can be worked out for that, so I'll leave this issue here.

Contributor guide

Tech stack
javascriptnodejs
Domain
build systemreleasedevops
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
node.jsgithub actionspkgci/cd
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review existing CI workflows in issues #121 and #148 for NPM and GitHub releases. Investigate using pkg to bundle freyr js into executables for all platforms. Address the challenges of periodically updating youtube dl and Apple Music API token by exploring automated update mechanisms or embedding the dependencies. Consult the repository's CI configuration files and the releases page for current build structure.