Skip to content

upbound/action-up-project

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

GitHub Actions for Upbound - up project

This action is used to build Upbound projects and optionally push them to the Upbound Marketplace. It requires up to be installed (you can use upbound/action-up action)

Usage

To install the latest version of up and use it in GitHub Actions workflows, create an Upbound API token, add it as a secret to your repository, and add the following step to your workflow:

- name: Checkout Repository
  uses: actions/checkout@v4

- name: Install and login with up
  uses: upbound/action-up@v1
  with:
    api-token: ${{ secrets.UP_API_TOKEN }}
    organization: my-org

- name: Build Upbound project
  uses: upbound/action-up-project@v1
- name: Checkout Repository
  uses: actions/checkout@v4

- name: Install and login with up
  uses: upbound/action-up@v1
  with:
    api-token: ${{ secrets.UP_API_TOKEN }}
    organization: my-org

- name: Build and Push Upbound project
  uses: upbound/action-up-project@v1
  with:
    push-project: true

Contributing

Note

You'll need to have a reasonably modern version of Node.js handy. If you are using a version manager like nodenv or nvm, you can run nodenv install in the root of your repository to install the version specified in package.json. Otherwise, 20.x or later should work!

  1. 🛠️ Install the dependencies

    npm install
  2. 🏗️ Package the JavaScript for distribution

    npm run bundle
  3. ✅ Run the tests

    $ npm test
    PASS  __tests__/main.test.js
     action
       ✓ installs the up cli successfully (2 ms)
       ✓ installs the up cli successfully without a v in front of the version (1 ms)
    
    PASS  __tests__/index.test.js
     index
       ✓ calls run when imported (1 ms)
    ...