ReaPack: Package Manager for REAPER (developer thread)

[loTrT]

hi i am slowly catching up with the reapack index! thank you all

I managed to use the cfillion/reapack-repository-template to automatically update the index.xml

i would like to understand a little better the reapack-index --amend command inside github

Where should i insert the --amend command ?
in the package version tag?
somewhere in the Github action workflows (deploy/check)?

my problem is that the index is updateted only if i change the value of the @version tag of the package, but i would only like to work on a v1.0 revisions and changing this v1.0

i have tried to put this command after the --commit command in deploy.yml but i have the following errors:

Commit the new index? [y/N] /opt/hostedtoolcache/Ruby/3.0.3/x64/lib/ruby/gems/3.0.0/gems/reapack-index-1.2.3/lib/reapack/index/cli.rb:275:in `getch': Inappropriate ioctl for device (Errno::ENOTTY)
from /opt/hostedtoolcache/Ruby/3.0.3/x64/lib/ruby/gems/3.0.0/gems/reapack-index-1.2.3/lib/reapack/index/cli.rb:275:in `prompt'
from /opt/hostedtoolcache/Ruby/3.0.3/x64/lib/ruby/gems/3.0.0/gems/reapack-index-1.2.3/lib/reapack/index/cli.rb:265:in `commit'
from /opt/hostedtoolcache/Ruby/3.0.3/x64/lib/ruby/gems/3.0.0/gems/reapack-index-1.2.3/lib/reapack/index/cli.rb:56:in `run'
from /opt/hostedtoolcache/Ruby/3.0.3/x64/lib/ruby/gems/3.0.0/gems/reapack-index-1.2.3/bin/reapack-index:8:in `block in <top (required)>'
from /opt/hostedtoolcache/Ruby/3.0.3/x64/lib/ruby/gems/3.0.0/gems/reapack-index-1.2.3/bin/reapack-index:8:in `catch'
from /opt/hostedtoolcache/Ruby/3.0.3/x64/lib/ruby/gems/3.0.0/gems/reapack-index-1.2.3/bin/reapack-index:8:in `<top (required)>'
from /opt/hostedtoolcache/Ruby/3.0.3/x64/bin/reapack-index:25:in `load'
from /opt/hostedtoolcache/Ruby/3.0.3/x64/bin/reapack-index:25:in `<main>'
1 modified package, 1 modified version
Error: Process completed with exit code 1.

[cfillion]

Users only receive update when the version number is increased. Ideally the version number should remain the same until the next version is finished, at which time the number is bumped to trigger the release.

You can add custom options in the file .reapack-index.conf at the root of the repository.

[cfillion]

ReaPack v1.2.4rc1

This is a pre-release update, so it must be selected for installation using the Package browser (unless the bleeding-edge mode is enabled in the options).

Added:

• Add an option to browse packages in each repository's install/update menu
• Match synonymous words when filtering packages (Options > Search for synonyms of common words) [p=2512900]

Fixed:

• Fix loading from a symlinked resource path on macOS Catalina and newer [#34]
• Fix the browser's filter text box not being auto-focused on macOS REAPER v6
• Fix typing parentheses in the browser's filter box
• Improve window positionning on Linux in multimonitor setups

Changed:

• Allow ReaPack to be installed as a symbolic link in UserPlugins on Linux and macOS
• Don't modify the database at every startup
• Rename "Upload packages" to "Package editor" in the browser's menu

[mpl]

Hi. Wasn't here for a long time.

Is there a possibility to force installation of specific package from API side?

[cfillion]

No, the best a script can currently do with the API is check whether it's installed and open the browser with a custom filter if not.

I'd still like to add a proper dependency system some day, but it's far from a priority...

[nikolalkc]

Originally Posted by mpl

Hi. Wasn't here for a long time.

Is there a possibility to force installation of specific package from API side?

This is something I also wanted to ask for.

I don't see it as a walkaround for dependencies.
It would be an amazing improvement for game audio.
You could define required scripts for every team member per project/studio/company and just install everything for everyone automatically through __startup.lua.

Currently we are can do this just for complete repositories, which is redundant cause we never need all those packages.

[cfillion]

Originally Posted by nikolalkc

I don't see it as a walkaround for dependencies.
It would be an amazing improvement for game audio.
You could define required scripts for every team member per project/studio/company and just install everything for everyone automatically through __startup.lua.

Sets of installed packages can be shared using the offline archive feature (although not automatically through __startup.lua).

[n0ne]

Originally Posted by cfillion

This happens in Catalina and newer only. Fixed in this build: https://ci.appveyor.com/api/buildjob...k-x86_64.dylib.

Hey cfillion,

I'm having the installation mismatch error too on macOS Montere. I have my Reaper folder in Dropbox and a symlink to it in my applications folder. The links of the builds you shared earlier don't work anymore. Is there anyway to work around this?

Thanks!
Jay

[cfillion]

The fix for that is included in v1.2.4rc1: https://github.com/cfillion/reapack/.../tag/v1.2.4rc1.

[n0ne]

That works, thank you!

[MonkeyBars]

Hey I was having a lot of issues getting scripts to update, and we realized that ReaPack doesn't treat version numbers in strict numeric order, but rather treats decimals like subintegers, so for example 1.222 is AFTER 1.3.

Is that intentional?

[cfillion]

Yes. It's (mostly) compatible with semantic versioning. https://semver.org/

Versions numbers are an infinite set of numerical and alphabetic components optionally separated by any non-alphanumerical character. (A version number containing at least one alphabetical component makes it a pre-release and gets special treatment.)

https://github.com/cfillion/reapack/...#version-names

[MonkeyBars]

Semver noted, thanks!!

[amagalma]

For some weeks (maybe months?) I have been getting this error with Upload Tools while trying to upload a new script or edit an existing one:


Any idea?

[cfillion]

Someone else had the issue a few days ago and deleting their fork solved it.

But first I'd like to figure out what is going on (to either fix the bug or show a better error message)... Could you check in your web browser's Developer Tools's Network tab which of these requests is failing?

[amagalma]

Does this help?

[cfillion]

Thanks! It looks like it can't find the commit it just created when making the new branch. What's the server response for the POST commits request, as well as the the client request data for that failing POST refs?

It should be like this, with the sha received from the commits sent back to the refs. The link in html_url should successfully show the created commit's contents.

raw commits response data
{
  "sha": "22b0dac2716fc21ea66b009fa908f5b0512efb88",
  "node_id": "C_kwDOCcq4CNoAKDIyYjBkYWMyNzE2ZmMyMWVhNjZiMDA5ZmE5MDhmNWIwNTEyZWZiODg",
  "url": "https://api.github.com/repos/cfillion/ReaScripts-1/git/commits/22b0dac2716fc21ea66b009fa908f5b0512efb88",
  "html_url": "https://github.com/cfillion/ReaScrip...08f5b0512efb88",
  "author": {
    "name": "Christian Fillion",
    "email": "cfillion@users.noreply.github.com",
    "date": "2022-01-26T22:07:46Z"
  },
  "committer": {
    "name": "Christian Fillion",
    "email": "cfillion@users.noreply.github.com",
    "date": "2022-01-26T22:07:46Z"
  },
  "tree": {
    "sha": "b264e280438103de0c293598374354a62d2e651f",
    "url": "https://api.github.com/repos/cfillion/ReaScripts-1/git/trees/b264e280438103de0c293598374354a62d2e651f"
  },
  "message": "Release arst v21",
  "parents": [
    {
      "sha": "39ea3823d0c9b1edc1c0e9dad64119da7d6728ae",
      "url": "https://api.github.com/repos/cfillion/ReaScripts-1/git/commits/39ea3823d0c9b1edc1c0e9dad64119da7d6728ae",
      "html_url": "https://github.com/cfillion/ReaScripts-1/commit/39ea3823d0c9b1edc1c0e9dad64119da7d6728ae"
    }
  ],
  "verification": {
    "verified": false,
    "reason": "unsigned",
    "signature": null,
    "payload": null
  }
}

raw refs request data
{"ref":"refs/heads/reapack.com_upload-1643234866334","sha":"22b0dac2716fc21ea66b009fa908f5b0512efb88"}

[amagalma]

Is it this?

raw commits response data:

{
"sha": "4b6deac81425993dca28cfcb283823fc76abf320",
"node_id": "C_kwDOBSLWadoAKDRiNmRlYWM4MTQyNTk5M2RjYTI4Y2ZjYjI 4MzgyM2ZjNzZhYmYzMjA",
"url": "https://api.github.com/repos/amagalma/ReaScripts/git/commits/4b6deac81425993dca28cfcb283823fc76abf320",
"html_url": "https://github.com/amagalma/ReaScrip...3823fc76abf320",
"author": {
"name": "amagalma",
"email": "[hidden]",
"date": "2022-01-26T23:04:31Z"
},
"committer": {
"name": "amagalma",
"email": "[hidden]",
"date": "2022-01-26T23:04:31Z"
},
"tree": {
"sha": "193a5fc958bef605d9f066a46d48de25cecc8fe5",
"url": "https://api.github.com/repos/amagalma/ReaScripts/git/trees/193a5fc958bef605d9f066a46d48de25cecc8fe5"
},
"message": "Release test v1.0",
"parents": [
{
"sha": "39ea3823d0c9b1edc1c0e9dad64119da7d6728ae",
"url": "https://api.github.com/repos/amagalma/ReaScripts/git/commits/39ea3823d0c9b1edc1c0e9dad64119da7d6728ae",
"html_url": "https://github.com/amagalma/ReaScripts/commit/39ea3823d0c9b1edc1c0e9dad64119da7d6728ae"
}
],
"verification": {
"verified": false,
"reason": "unsigned",
"signature": null,
"payload": null
}
}

raw refs request data:

{"ref":"refs/heads/reapack.com_upload-1643238271686","sha":"4b6deac81425993dca28cfcb283823fc76abf320"}

[cfillion]

That looks good and the commit it created actually exists. I wonder if it's just a timing issue...

I pushed a small change to make it retry creating the branch up to 5 times in 30 seconds. Does that improves things?

[amagalma]

Do you want me to send you the same kind of info as before?

P.S. I tried from Edge browser to see if it makes any difference, but it's the same..

[cfillion]

Not just a timing issue then... What's the response data and response headers for those 404?

[amagalma]

1st 404:
response data:

{
"message": "Not Found",
"documentation_url": "https://docs.github.com/rest/reference/git#create-a-reference"
}

response header:

HTTP/2 404 Not Found
server: GitHub.com
date: Thu, 27 Jan 2022 13:46:11 GMT
content-type: application/json; charset=utf-8
x-oauth-scopes: public_repo
x-accepted-oauth-scopes: repo
x-oauth-client-id: fdf42a6c354a7e6823f3
x-github-media-type: github.v3; format=json
x-ratelimit-limit: 5000
x-ratelimit-remaining: 4989
x-ratelimit-reset: 1643294736
x-ratelimit-used: 11
x-ratelimit-resource: core
access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset
access-control-allow-origin: *
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
content-security-policy: default-src 'none'
vary: Accept-Encoding, Accept, X-Requested-With
content-encoding: gzip
x-github-request-id: 32E6:D183:7350E:7558B:61F2A223
X-Firefox-Spdy: h2

2nd 404:

{
"message": "Not Found",
"documentation_url": "https://docs.github.com/rest/reference/git#create-a-reference"
}

HTTP/2 404 Not Found
server: GitHub.com
date: Thu, 27 Jan 2022 13:46:14 GMT
content-type: application/json; charset=utf-8
x-oauth-scopes: public_repo
x-accepted-oauth-scopes: repo
x-oauth-client-id: fdf42a6c354a7e6823f3
x-github-media-type: github.v3; format=json
x-ratelimit-limit: 5000
x-ratelimit-remaining: 4988
x-ratelimit-reset: 1643294736
x-ratelimit-used: 12
x-ratelimit-resource: core
access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset
access-control-allow-origin: *
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
content-security-policy: default-src 'none'
vary: Accept-Encoding, Accept, X-Requested-With
content-encoding: gzip
x-github-request-id: 32E6:D183:73AD6:75B8C:61F2A225
X-Firefox-Spdy: h2

3d:

{
"message": "Not Found",
"documentation_url": "https://docs.github.com/rest/reference/git#create-a-reference"
}

HTTP/2 404 Not Found
server: GitHub.com
date: Thu, 27 Jan 2022 13:46:18 GMT
content-type: application/json; charset=utf-8
x-oauth-scopes: public_repo
x-accepted-oauth-scopes: repo
x-oauth-client-id: fdf42a6c354a7e6823f3
x-github-media-type: github.v3; format=json
x-ratelimit-limit: 5000
x-ratelimit-remaining: 4987
x-ratelimit-reset: 1643294736
x-ratelimit-used: 13
x-ratelimit-resource: core
access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset
access-control-allow-origin: *
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
content-security-policy: default-src 'none'
vary: Accept-Encoding, Accept, X-Requested-With
content-encoding: gzip
x-github-request-id: 32E6:D183:744DA:7659F:61F2A22A
X-Firefox-Spdy: h2

4th:

{
"message": "Not Found",
"documentation_url": "https://docs.github.com/rest/reference/git#create-a-reference"
}

HTTP/2 404 Not Found
server: GitHub.com
date: Thu, 27 Jan 2022 13:46:25 GMT
content-type: application/json; charset=utf-8
x-oauth-scopes: public_repo
x-accepted-oauth-scopes: repo
x-oauth-client-id: fdf42a6c354a7e6823f3
x-github-media-type: github.v3; format=json
x-ratelimit-limit: 5000
x-ratelimit-remaining: 4986
x-ratelimit-reset: 1643294736
x-ratelimit-used: 14
x-ratelimit-resource: core
access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset
access-control-allow-origin: *
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
content-security-policy: default-src 'none'
vary: Accept-Encoding, Accept, X-Requested-With
content-encoding: gzip
x-github-request-id: 32E6:D183:7520E:772FD:61F2A230
X-Firefox-Spdy: h2

5th:

{
"message": "Not Found",
"documentation_url": "https://docs.github.com/rest/reference/git#create-a-reference"
}

HTTP/2 404 Not Found
server: GitHub.com
date: Thu, 27 Jan 2022 13:46:33 GMT
content-type: application/json; charset=utf-8
x-oauth-scopes: public_repo
x-accepted-oauth-scopes: repo
x-oauth-client-id: fdf42a6c354a7e6823f3
x-github-media-type: github.v3; format=json
x-ratelimit-limit: 5000
x-ratelimit-remaining: 4985
x-ratelimit-reset: 1643294736
x-ratelimit-used: 15
x-ratelimit-resource: core
access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset
access-control-allow-origin: *
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
content-security-policy: default-src 'none'
vary: Accept-Encoding, Accept, X-Requested-With
content-encoding: gzip
x-github-request-id: 32E6:D183:761EE:78321:61F2A239
X-Firefox-Spdy: h2

[cfillion]

Thanks for all the details! I was hoping it would say what exactly isn't found.

Last troubleshooting attempt before just deleting the fork: does updating the fork fixes it? ("Fetch upstream" button on https://github.com/amagalma/ReaScripts/)

[amagalma]

Originally Posted by cfillion

Last troubleshooting attempt before just deleting the fork: does updating the fork fixes it? ("Fetch upstream" button on https://github.com/amagalma/ReaScripts/)

That was it! Problem solved! Thank you for your help!

[Meo-Ada Mespotine]

I tried to upload a script using the uploader on reapack.com and when the page tries to create a pull request, it says "Error: Not Found" after it uploaded the files.

What could be the reason for this and what could potentially not have been found?

Reloading the page to be sure that everything was loaded properly didn't do anything. The autorization on GitHub seems to have worked properly...

Tested on Opera 82.0.4227.58

[cfillion]

Originally Posted by Meo-Ada Mespotine

What could be the reason for this and what could potentially not have been found?

Seems to happen sometimes when the fork is too out of date. See the workaround two posts above.

[Meo-Ada Mespotine]

Ahh, yup, fetching did the job and now it's working.

Thnx

[Zeno]

Hi, I have a question.
I have sent a pull request to ReaTeam repository 5 days ago. And it still has the status "open" - "1 workflow waiting for approval".
Did I make a mistake? Is there something else I need to do in addition? Or is it just that no one has had the time to review the code yet?

I only ask because I don't have any experience with Github or ReaPack.

[Zeno]

Guys? After 15 days, nothing has happened with my pull request. It is still pending without any response. So I ask again, did I miss something?
Would be nice if someone could give me a short answer so I at least know what's going on. thanks
https://github.com/ReaTeam/JSFX/pull/254

[cfillion]

Originally Posted by Zeno

https://github.com/ReaTeam/JSFX/pull/254

Oops, took care of it now!

[Zeno]

Originally Posted by cfillion

Oops, took care of it now!

Great, thank you!

[cfillion]

ReaPack v1.2.4rc2

• Add an option in the browser to enable pre-releases per installed package [#46]
• Fix unsetting version pin at the same time as installing or updating

[Ruxton]

Originally Posted by cfillion

I'd still like to add a proper dependency system some day, but it's far from a priority...

I definitely understand the reluctance to tackle it, but it's becoming a bit of a need as people are leaning more on other extensions in their scripts/extensions.

I think it's far better to tackle that hurdle now and define the spec for it, rather than further down the track with more users and repos in ReaPack that have to catch up to the idea.

[daniellumertz]

for releasing a pre release version I just need to write 'pre%d'after the version? like in :

-- @version 1.4pre1
-- @author Daniel Lumertz
-- @license MIT
-- @provides
--    [nomain] utils/*.lua
--    [nomain] Chunk Functions.lua
etc...

[cfillion]

Yes. Pre-releases are version numbers containing any letters.

[mschnell]

Hi cfillion,
Keith is doing descriptions for multiple plugins (see -> https://forum.cockos.com/showthread.php?t=266309).

Of course the best place to provide such information is the ReaPack database.

Is it possible to upload / include descriptions without any code in the database ?

If not (or not in a decent way) could you add such feature ?

IMHO it would be wonderful to have a searchable description e.g. of the Reaper stock plugins.

-Michael

[cfillion]

Documenting things that aren't installable packages would be out of scope for a package manager.

However there could very well be a package that installs a PDF hosted on some file host (eg. Stash).

[mschnell]

That is not what I think would be the way to go. IMHO the most important argument is that these descriptions should be searchable together with the "real" plugins managed in the database.

In fact I don't see why it would be not viable (or possible) to upload a JSFX with no code, but just the description part (pointing the user somehow to the plugin itself - be it Reaper stock distribution or whatever). Of course ReaPack should prevent such stubs from being installed, but that's not absolutely necessary (nor hard to do I suppose).
-Michael

[nofish]

Originally Posted by mschnell

In fact I don't see why it would be not viable (or possible) to upload a JSFX with no code, but just the description part (pointing the user somehow to the plugin itself - be it Reaper stock distribution or whatever). Of course ReaPack should prevent such stubs from being installed, but that's not absolutely necessary (nor hard to do I suppose).

From Wikipedia

A package manager or package-management system is a collection of software tools that automates the process of installing, upgrading, configuring, and removing computer programs for a computer in a consistent manner.

So while I like the idea of having a searchable JSFX description database, I agree with cfillion that's not within the scope of ReaPack imo.

[mschnell]

I don't think it's necessary to restrict ReaPack to being a "Package Manager".

IMHO it should be a the best possible tool to help Reaper users find (and if possible install) the plugins he searches for.

-Michael