https://github.com/architect/action-build

https://github.com/architect/action-build

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/architect/action-build
• Owner: architect
• License: apache-2.0
• Created: 2022-04-14T17:30:10.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T20:12:30.000Z (about 2 years ago)
• Last Synced: 2025-02-25T07:16:14.231Z (over 1 year ago)
• Size: 15.6 KB
• Stars: 3
• Watchers: 5
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Architect Build Action

![Architect logo](https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-light-500b%402x.png#gh-dark-mode-only)

![Architect logo](https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-500b%402x.png#gh-light-mode-only)

This is a GitHub Action that builds an architect application and runs the automated tests.

## How does it work?

When called the action will:

- checkout the project

- set up node.js v14

- installs dependencies (works with npm, pnpm and yarn)

- runs `npm run vendor` if present

- runs `arc hydrate`

- runs `npm test`

## Usage

Typically, you will want to add this action as the first step in a workflow. Then if the tests pass you can send a message to Discord or Slack.

For example:

```yaml

jobs:

  # Test the build

  build:

    # Setup

    runs-on: ubuntu-latest

    # Go

    steps:

      - name: Build App

        uses: architect/action-build@v3

      - name: Notify

        uses: sarisia/actions-status-discord@v1

        # Only fire alert once

        if: github.ref == 'refs/heads/main' && failure() && matrix.node-version == '14.x' && matrix.os == 'ubuntu-latest'

        with:

          webhook: ${{ secrets.DISCORD_WEBHOOK }}

          title: "build and test"

          color: 0x222222

          username: GitHub Actions

```

## Options

This action has a few options you can configure:

| Key | Required | Value | Default | Description |

| - | - | - | - | - |

| use_lock_file | No | Boolean | true | By default, this action will use a lock file like package-lock.json, npm-shrinkwrap.json or yarn.lock. You can set `useLockFile: false` to use just package.json |

| node-version | No | Number | 14 | The node-version input is optional. If not supplied, the node version defaults to 14.  |

## Contributing

[Find out more about contributing to Architect](https://arc.codes/docs/en/about/contribute)