Skip to content

Commit 1db397c

Browse files
committed
Написан readme и дополнен action.yml.
1 parent eb27e94 commit 1db397c

2 files changed

Lines changed: 59 additions & 2 deletions

File tree

README.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,58 @@
1-
# setup-oscript
1+
# Setup-Onescript
2+
3+
Setup-Onescript позволяет использовать в действия Github Action [Onescript](https://oscript.io/). При установке используется другой проект [OVM](https://github.com/oscript-library/ovm) - OneScript Version Manager.
4+
5+
## Использование
6+
7+
Описание действия [action.yml](action.yml)
8+
9+
### Базовый пример
10+
11+
```yaml
12+
- uses: actions/checkout@v2
13+
- uses: otymko/setup-onescript@v1
14+
with:
15+
version: 1.3.0 # Требуемая версия OneScript
16+
- run: oscript /path/to/script/test.os
17+
```
18+
19+
Параметр `version` поддерживает следующие значения:
20+
* 1.0.21
21+
* 1.2.0
22+
* 1.3.0
23+
* dev (текущая ночная сборка)
24+
25+
### Использование matrix
26+
27+
```yaml
28+
jobs:
29+
build:
30+
runs-on: ubuntu-latest
31+
strategy:
32+
matrix:
33+
oscript_version: [1.2.0, 1.3.0, dev]
34+
name: Тестирование проекта
35+
steps:
36+
- uses: actions/checkout@v2
37+
- name: Установка Onescript
38+
uses: otymko/setup-onescript@v1
39+
with:
40+
java-version: ${{ matrix.oscript_version }}
41+
- run: oscript /path/to/script/test.os
42+
43+
```
44+
45+
### Пример использования
46+
47+
Этот Action используется в проекте [GitRules](https://github.com/otymko/gitrules). В этом проекте реализован workflow для тестирования.
48+
49+
# Лицензия
50+
51+
Данный проект размещен под лицензией [MIT License](LICENSE)
52+
53+
# Контрибьютерам
54+
55+
Доработка проводится по git-flow.
56+
57+
58+

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: 'Setup your runner with Onescript'
33
author: 'otymko'
44
inputs:
55
version:
6-
description: 'Version of Onescript to use'
6+
description: 'Version of Onescript to use. Support value: 1.0.21, 1.2.0, 1.3.0, dev'
77
runs:
88
using: 'node12'
99
main: 'dist/index.js'

0 commit comments

Comments
 (0)