Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kateinoigakukun committed Oct 7, 2022
1 parent b3079c4 commit 720f9b4
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 102 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 GitHub Actions
Copyright (c) 2019 Yuta Saito

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
121 changes: 20 additions & 101 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,116 +1,35 @@
# Create a JavaScript Action
# setup-swiftwasm

<p align="center">
<a href="https://github.com/actions/javascript-action/actions"><img alt="javscript-action status" src="https://github.com/actions/javascript-action/workflows/units-test/badge.svg"></a>
</p>
A GitHub Action that downloads a SwiftWasm toolchain and adds it to the `PATH`.

Use this template to bootstrap the creation of a JavaScript action.:rocket:

This template includes tests, linting, a validation workflow, publishing, and versioning guidance.

If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)

## Create an action from this template

Click the `Use this Template` and provide the new repo details for your action

## Code in Main

Install the dependencies

```bash
npm install
```

Run the tests :heavy_check_mark:

```bash
$ npm test

PASS ./index.test.js
✓ throws invalid number (3ms)
wait 500 ms (504ms)
test runs (95ms)
...
```

## Change action.yml

The action.yml defines the inputs and output for your action.

Update the action.yml with your name, description, inputs and outputs for your action.

See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)

## Change the Code

Most toolkit and CI/CD operations involve async operations so the action is run in an async function.

```javascript
const core = require('@actions/core');
...

async function run() {
try {
...
}
catch (error) {
core.setFailed(error.message);
}
}

run()
```

See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.

## Package for distribution

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.
## Usage

Run prepare
To run the action with the latest SwiftWasm toolchain, add the following to your workflow file:

```bash
npm run prepare
```yaml
- uses: swiftwasm/setup-swiftwasm@v1
- run: swift --version # `swift` command in SwiftWasm
```

Since the packaged index.js is run from the dist folder.
A specific toolchain version can be specified with the `swift-version` input:

```bash
git add dist
```yaml
- uses: swiftwasm/setup-swiftwasm@v1
with:
swift-version: "wasm-5.6.0-RELEASE"
```

## Create a release branch

Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.

Checkin to the v1 release branch
You can also specify nightly toolchains:

```bash
git checkout -b v1
git commit -a -m "v1 release"
```

```bash
git push origin v1
```yaml
- uses: swiftwasm/setup-swiftwasm@v1
with:
swift-version: "wasm-DEVELOPMENT-SNAPSHOT-2022-10-04-a"
```

Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! :rocket:

See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
You can find the list of available toolchain versions on the [SwiftWasm Releases page](https://github.com/swiftwasm/swift/releases).

## Usage

You can now consume the action by referencing the v1 branch

```yaml
uses: actions/javascript-action@v1
with:
milliseconds: 1000
```
## Supported Platforms

See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
The action currently supports macOS and Ubuntu runners.

0 comments on commit 720f9b4

Please sign in to comment.