npmpackage.info

Gathering detailed insights and metrics for install-artifact-from-github

install-artifact-from-github - 1.4.0 | npmpackage.info

install-artifact-from-github

No-dependency micro helper for developers of binary addons for Node that checks the cache for an artifact before attempting to build a project. Save time for your users!

1.4.0

NOASSERTION

JavaScript

20.74 kB

4.2

Installations

npm install install-artifact-from-github

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

24.0.1

NPM Version

11.3.0 Pull Requests

Open

0

Total

3

Closed

1

Merged

2

Issues

Open

0

Total

4

Closed

4

Releases

Unable to fetch releases

Languages

JavaScript

Shell

JavaScript (94.86%)

Shell (5.14%)

Developer

uhop

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

NOASSERTION License

6 Stars

63 Commits

3 Forks

2 Watchers

1 Branches

3 Contributors

Updated on May 12, 2025

Maintainers

View All 3 Contributors

Package Meta Information

Latest Version

1.4.0

Package Id

install-artifact-from-github@1.4.0

Unpacked Size

20.74 kB

Size

6.66 kB

File Count

NPM Version

11.3.0

Node Version

24.0.1

Published on

May 12, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

No dependencies detected.

install-artifact-from-github

This is a no-dependency micro helper for developers of binary addons for Node. It is literally two small one-file utilities integrated with GitHub releases. The project solves two problems:

save-to-github-cache saves a binary artifact to a Github release according to the platform, architecture, and Node ABI.
- Designed to be used with GitHub actions.
install-from-cache retrieves a previously saved artifact, tests if it works properly, and rebuilds a project from sources in the case of failure.

In general, it can save your users from a long recompilation and, in some cases, even save them from installing build tools. By using GitHub facilities (Releases and Actions) the whole process of publishing and subsequent installations are secure, transparent, painless, inexpensive, or even free for public repositories.

How to install

Installation:

npm install --save install-artifact-from-github

How to use

In your package.json (pseudo-code with comments):

1{
2  // your custom package.json stuff
3  // ...
4  "scripts": {
5    // your scripts go here
6    // ...
7
8    // saves an artifact
9    "save-to-github": "save-to-github-cache --artifact build/Release/ABC.node",
10
11    // installs using pre-created artifacts
12    "install": "install-from-cache --artifact build/Release/ABC.node",
13
14    // used by "install" to test the artifact
15    "verify-build": "node scripts/verify-build.js"
16
17    // used by "install" to rebuild from sources
18    "rebuild": "node-gyp rebuild"
19  }
20}

Examples of GitHub actions can be found in the documentation.

Documentation

The full documentation is available in the wiki.

Release history

1.4.0 added support for uncompresed artifacts and selective compression format.
1.3.5 propagated the previous timeout fix to the saving utility.
1.3.4 minor fixes + a timeout fix: use a new default agent for GET. Thx, Laura Hausmann.
1.3.3 minor refactor, added support for a personal token.
1.3.2 added support for the 204 response and error logging.
1.3.1 added a way to specify a custom build, thx Grisha Pushkov + a test.
1.3.0 enhanced support for custom mirrors.
1.2.0 support for NPM >= 7.
1.1.3 technical release: updated docs.
1.1.2 technical release: updated docs.
1.1.1 numerous bugfixes to please Github REST API.
1.1.0 moved save-to-github here from a separate project, reduced 3rd-party dependencies.
1.0.2 fixed a yarn-specific bug.
1.0.1 fixed a bug in the environment variable parameter.
1.0.0 initial release (extracted from node-re2).

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

9

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

4

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.2

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More