readme.md

Architect Build Action

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:

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