https://github.com/bcdevices/pltcloud-action

PLTcloud GitHub Action
https://github.com/bcdevices/pltcloud-action

github-actions pltcloud

Last synced: 12 days ago
JSON representation

PLTcloud GitHub Action

• Host: GitHub
• URL: https://github.com/bcdevices/pltcloud-action
• Owner: bcdevices
• License: apache-2.0
• Created: 2019-11-04T19:58:04.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-28T00:31:26.000Z (over 1 year ago)
• Last Synced: 2024-09-21T15:09:15.627Z (about 2 months ago)
• Topics: github-actions, pltcloud
• Language: Shell
• Homepage: https://github.com/marketplace/actions/pltcloud-action
• Size: 11.7 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PLTcloud Action 

The PLTcloud action allows publishing firmware releases directly

to [BCD](https://www.bcdevices.com/)'s [PLTcloud](https://www.bcdevices.com/plt/) backend.

It allows you to upload a release to PLTcloud as part of your CI workflow.

## Input variables

Mandatory:

| input          | description                      |

| -------------- | -------------------------------- |

| `API_TOKEN`    | PLTcloud API token.              |

| `PROJECT_UUID` | Project id for PLTcloud project. |

| `FILES`        | List of files for upload. Files can be specified with patterns such as: `**/prefix*`, `grandparent/**/child?`, `**/parent/*`, or even just `**` |

| `VERSION`      | Release version. (default: `${{ github.ref }}`) |

Optional:

| input              | description                       |

| ------------------ | --------------------------------- |

| `VERBOSE`          | Verbose output (default: `false`) |

| `DEPLOYMENT_GROUP_UUID` | Deployment Group UUID |

| `AUTO_DEPLOY`      | Auto deploy release to PLT (default: `false`) |

## Usage

Step 1: Validate firmware build and test plans

==============================================

In order to upload a release, the PLT test plan, and any associated assets

such as DUT firmware must be available in a directory.

Setup a GitHub action to build the firmware and copy test plans

to a known directory.

Step 2: Configure project and token secrets

===========================================

- Log in to PLTcloud and select the `Project` menu item from the

  project drop-down in the top banner.

- Copy the ``UUID`` from the project detail page and a secret named

  ``PROJECT_UUID`` in your GitHub project.

- Select ``API Tokens`` from the drop-down menu under the user menu in PLTcloud

- Select ``Add Release Token``, login and copy the ``Release Upload Token``

- Add the release token to GitHub secrets and name it ``API_TOKEN``

Step 3: Add the PLTcloud action to the GitHub Actions Workflow

==============================================================

Add a step in the ``.github/workflows/main.yml`` actions workflow,

after the steps that build the firmware:

```yml

- uses: bcdevices/[email protected]

  with:

    FILES: dist/*

    API_TOKEN: ${{ secrets.API_TOKEN }}

    PROJECT_UUID: ${{ secrets.PROJECT_UUID }}

    VERSION: ${{ github.ref }}

```