Skip to content

Commit

Permalink
Написан readme и дополнен action.yml.
Browse files Browse the repository at this point in the history
  • Loading branch information
otymko committed Apr 14, 2020
1 parent eb27e94 commit 1db397c
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 2 deletions.
59 changes: 58 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,58 @@
# setup-oscript
# Setup-Onescript

Setup-Onescript позволяет использовать в действия Github Action [Onescript](https://oscript.io/). При установке используется другой проект [OVM](https://github.com/oscript-library/ovm) - OneScript Version Manager.

## Использование

Описание действия [action.yml](action.yml)

### Базовый пример

```yaml
- uses: actions/checkout@v2
- uses: otymko/setup-onescript@v1
with:
version: 1.3.0 # Требуемая версия OneScript
- run: oscript /path/to/script/test.os
```
Параметр `version` поддерживает следующие значения:
* 1.0.21
* 1.2.0
* 1.3.0
* dev (текущая ночная сборка)

### Использование matrix

```yaml
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
oscript_version: [1.2.0, 1.3.0, dev]
name: Тестирование проекта
steps:
- uses: actions/checkout@v2
- name: Установка Onescript
uses: otymko/setup-onescript@v1
with:
java-version: ${{ matrix.oscript_version }}
- run: oscript /path/to/script/test.os
```

### Пример использования

Этот Action используется в проекте [GitRules](https://github.com/otymko/gitrules). В этом проекте реализован workflow для тестирования.

# Лицензия

Данный проект размещен под лицензией [MIT License](LICENSE)

# Контрибьютерам

Доработка проводится по git-flow.



2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: 'Setup your runner with Onescript'
author: 'otymko'
inputs:
version:
description: 'Version of Onescript to use'
description: 'Version of Onescript to use. Support value: 1.0.21, 1.2.0, 1.3.0, dev'
runs:
using: 'node12'
main: 'dist/index.js'

0 comments on commit 1db397c

Please sign in to comment.