https://github.com/tool3/ncc

github action to compile your nodejs code and push to a destination branch
https://github.com/tool3/ncc

continuous-integration github-action nodejs

Last synced: 28 days ago
JSON representation

github action to compile your nodejs code and push to a destination branch

• Host: GitHub
• URL: https://github.com/tool3/ncc
• Owner: tool3
• License: mit
• Created: 2020-03-10T05:07:00.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T14:47:21.000Z (7 months ago)
• Last Synced: 2024-10-28T17:59:31.494Z (about 2 months ago)
• Topics: continuous-integration, github-action, nodejs
• Language: JavaScript
• Homepage:
• Size: 8.43 MB
• Stars: 1
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ncc action   

![ncc](https://github.com/tool3/ncc/workflows/ncc/badge.svg?branch=master)   

github action to compile your github action and push to a destination branch!   

uses `@vercel/ncc`

# motivation

* work on other devices which do not have a terminal

* code directly on `github` - if that's a thing

* `github hackathon` 🎉

# usage    

```yaml

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@master

    - uses: tool3/ncc@master

      with:

        github_token: ${{ secrets.GITHUB_TOKEN }}

        src: 'index.js'

    - uses: actions/upload-artifact@v1    <-- optional (upload dist directory)

      with:

        name: dist

        path: dist/

```

this will:

* compile `index.js` from the repo root directory.

* push the compiled `dist` directory to the destination branch.

# options

### `github_token`   

   **required**   

   Github access token

### `src`   

  **required**   

  default: `index.js`

### `branch`   

  destination branch   

  default: `master`

### `commit_msg`   

  commit message used when pushing dist   

  default: `dist release 📦`

### `ncc_args`   

  command seperated args for ncc   

  exmaple: `'-o, other_dist, -C'` 

### `allow_unrelated`   

  adds `--allow-unrelated-histories` when perform `git pull`

  default: `true`