Skip to content

Commit

Permalink
Add some basic usage documentation
Browse files Browse the repository at this point in the history
Some of the current input and output values
are purposely left undocumented, since they
are likely to change or be removed in the next major release.

Signed-off-by: Jonathan Schwender <[email protected]>
  • Loading branch information
jschwe committed Oct 7, 2024
1 parent e243688 commit 98316c3
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,41 @@
# OHOS SDK

This is a simple GitHub action to automatically download and install the OpenHarmony SDK,
so you can use it in your GitHub actions workflow.
so you can use it in your GitHub actions workflow.

## Usage

```yaml
name: Main

on: push

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup OpenHarmony SDK
uses: openharmony-rs/[email protected]
```
### Options
**inputs**:
| Name | Type | Default | Description |
|------------|---------|---------|----------------------------------------------------------------------------------------------------------------------------|
| version | String | 4.1 | Version of the OpenHarmony SDK (e.g. `4.0`, `4.1` or `5.0`) |
| cache | Boolean | true | Uses the GitHub actions cache to cache the SDK when enabled. |
| components | String | all | SDK components that should be added. `all` or semicolon seperated list of components. |
| mirror | Boolean | true | Download from Github Releases mirror of the SDK if possible. |

**outputs**:


| Name | Type | Description |
|-----------------|--------|--------------------------------------------------------|
| api-version | String | API Version of the SDK (e.g. `12` for OpenHarmony 5.0) |
| sdk-version | String | Specific SDK version (e.g. `4.1.7.5`) |
| ohos_sdk_native | String | Path to the `native` directory in the OpenHarmony SDK. |

0 comments on commit 98316c3

Please sign in to comment.