Skip to content

Commit

Permalink
Update docs for v1
Browse files Browse the repository at this point in the history
  • Loading branch information
laupow committed May 10, 2023
1 parent 7ac002e commit f74a580
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
# Particle Firmware Upload Action
[![Build and Test](https://github.com/particle-iot/firmware-upload-action/actions/workflows/test.yml/badge.svg)](https://github.com/particle-iot/firmware-upload-action/actions/workflows/test.yml)


A GitHub Action for uploading firmware binaries to Particle products.

This action does not trigger OTA updates to devices. It only uploads the binary to the Particle cloud.
Other Actions for firmware development: [Compile](https://github.com/particle-iot/compile-action) | [Flash Device](https://github.com/particle-iot/flash-device-action) | Firmware Upload

> This action is currently in public beta. Please [report](https://community.particle.io/) any issues you encounter.
> This project is currently under development with no stable v1 release yet.
Documentation refers to the `main` branch, but please be aware that stability guarantees are not provided at this stage.

## Usage

```yaml
- uses: particle-iot/firmware-upload-action@main
- uses: particle-iot/firmware-upload-action@v1
with:
# Particle access token
# Required: true
Expand Down Expand Up @@ -41,6 +39,8 @@ Documentation refers to the `main` branch, but please be aware that stability gu
description: ''
```

Also see official [Particle documentation](https://docs.particle.io/firmware/best-practices/github-actions/) for more details.

## Example Pipeline

This is an example of a GitHub Actions pipeline that compiles a firmware project and uploads the compiled binary as an artifact.
Expand Down Expand Up @@ -69,7 +69,7 @@ jobs:

- name: Compile application
id: compile
uses: particle-iot/compile-action@main
uses: particle-iot/compile-action@v1
with:
particle-platform-name: 'boron'
device-os-version: 'latest-lts'
Expand All @@ -91,7 +91,7 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}

- name: Upload product firmware to Particle
uses: particle-iot/firmware-upload-action@main
uses: particle-iot/firmware-upload-action@v1
with:
particle-access-token: ${{ secrets.PARTICLE_ACCESS_TOKEN }}
firmware-path: ${{ steps.compile.outputs.artifact-path }}
Expand Down

0 comments on commit f74a580

Please sign in to comment.