Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uhop/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!
https://github.com/uhop/install-artifact-from-github
binary-addons caching github-releases
Last synced: about 1 month ago
JSON representation
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!
- Host: GitHub
- URL: https://github.com/uhop/install-artifact-from-github
- Owner: uhop
- License: other
- Created: 2020-07-14T04:25:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-15T08:17:19.000Z (about 1 year ago)
- Last Synced: 2024-10-09T13:28:08.070Z (about 1 month ago)
- Topics: binary-addons, caching, github-releases
- Language: JavaScript
- Homepage:
- Size: 51.8 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# install-artifact-from-github [![NPM version][npm-img]][npm-url]
[npm-img]: https://img.shields.io/npm/v/install-artifact-from-github.svg
[npm-url]: https://npmjs.org/package/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](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/about-releases). The project solves two problems:
* [save-to-github-cache](./Saving) saves a binary artifact to a Github release according to the platform, architecture, and Node ABI.
* Designed to be used with [GitHub actions](https://github.com/features/actions).
* [install-from-cache](./Installing) 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](https://docs.github.com/en/github/administering-a-repository/about-releases)
and [Actions](https://github.com/features/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):
```js
{
// your custom package.json stuff
// ...
"scripts": {
// your scripts go here
// ...
// saves an artifact
"save-to-github": "save-to-github-cache --artifact build/Release/ABC.node",
// installs using pre-created artifacts
"install": "install-from-cache --artifact build/Release/ABC.node",
// used by "install" to test the artifact
"verify-build": "node scripts/verify-build.js"
// used by "install" to rebuild from sources
"rebuild": "node-gyp rebuild"
}
}
```
Examples of GitHub actions can be found in the documentation.
## Documentation
The full documentation is available in the [wiki](https://github.com/uhop/install-artifact-from-github/wiki).
## Release history
- 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](https://github.com/zotanmew).*
- 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](https://github.com/reepush) + 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](https://github.com/uhop/node-re2)).*