https://github.com/dgarc359/node-binary-github-actions-template

Template repository for creating a node binary via github actions
https://github.com/dgarc359/node-binary-github-actions-template

Last synced: about 1 month ago
JSON representation

Template repository for creating a node binary via github actions

• Host: GitHub
• URL: https://github.com/dgarc359/node-binary-github-actions-template
• Owner: Dgarc359
• Created: 2024-01-17T05:46:14.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-01-18T23:08:34.000Z (11 months ago)
• Last Synced: 2024-04-23T20:50:07.826Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 24.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This example project builds and deploys a node.js binary called 'build-a-readme' which can be used with `npx barm` or `yarn barm` upon installation. This repository is a nice template to jump start a node.js project where you need to build a binary combined with github actions.

[Check out the deployed package](https://www.npmjs.com/package/build-a-readme)

> ⚠️ Your github actions will more than likely fail until you change the package name in your `package.json`

# Usage

The github action in this project is designed to create a release on github and

publish an artifact on npm when a new tag is pushed.

For that reason, the current workflow is to line up your tag with your package.json version

With this repository, you should target main to be your 'release'

pipeline. If you want to modify which branch releases to npm,

modify the publish-to-npmjs.yaml file.

# Example Project Development guide

> ⚠️ This dev guide is for the example project

Link your local version to a dummy client for testing

```bash

# in build-a-readme/

npm link

# in a dummy consumer project

npm link build-a-readme

```