@vkontakte/vk-miniapps-deploy 0.1.6 → 0.1.8-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/CODEOWNERS +2 -2
- package/.github/ISSUE_TEMPLATE/bug_report.yml +58 -0
- package/.github/actions/bump-version/action.yml +39 -0
- package/.github/actions/complete-publish/action.yml +48 -0
- package/.github/actions/setup/action.yml +23 -0
- package/.github/pull_request_template.md +57 -0
- package/.github/workflows/publish.yml +25 -22
- package/.github/workflows/publish_prerelease.yml +58 -0
- package/README.md +13 -11
- package/index.js +0 -7
- package/package.json +1 -2
package/.github/CODEOWNERS
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
*
|
|
2
|
-
.github
|
|
1
|
+
* @VKCOM/vk-miniapp
|
|
2
|
+
.github @VKCOM/vk-sec
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
name: Bug Report
|
|
2
|
+
description: Помогите нам сделать библиотеку vk-miniapps-deploy более стабильной
|
|
3
|
+
title: '[Bug]: '
|
|
4
|
+
body:
|
|
5
|
+
- type: textarea
|
|
6
|
+
id: what-happened
|
|
7
|
+
attributes:
|
|
8
|
+
label: Описание
|
|
9
|
+
description: Расскажите о вашей проблеме.
|
|
10
|
+
validations:
|
|
11
|
+
required: true
|
|
12
|
+
- type: input
|
|
13
|
+
id: version
|
|
14
|
+
attributes:
|
|
15
|
+
label: Версия vk-miniapps-deploy
|
|
16
|
+
description: Поможет локализовать проблему.
|
|
17
|
+
validations:
|
|
18
|
+
required: true
|
|
19
|
+
- type: dropdown
|
|
20
|
+
id: platform
|
|
21
|
+
attributes:
|
|
22
|
+
label: Платформа
|
|
23
|
+
description: Выберите одну или несколько платформ, на которых воспроизводится ошибка.
|
|
24
|
+
multiple: true
|
|
25
|
+
options:
|
|
26
|
+
- Windows
|
|
27
|
+
- Linux
|
|
28
|
+
- MacOS
|
|
29
|
+
validations:
|
|
30
|
+
required: true
|
|
31
|
+
- type: textarea
|
|
32
|
+
id: steps
|
|
33
|
+
attributes:
|
|
34
|
+
label: Шаги воспроизведения
|
|
35
|
+
description: Желательно описать последовательность, при которой ошибка стабильно воспроизводится.
|
|
36
|
+
validations:
|
|
37
|
+
required: true
|
|
38
|
+
- type: textarea
|
|
39
|
+
id: expectations
|
|
40
|
+
attributes:
|
|
41
|
+
label: Ожидаемое поведение
|
|
42
|
+
description: Если считаете, что из описания ожидаемое поведение непонятно.
|
|
43
|
+
validations:
|
|
44
|
+
required: true
|
|
45
|
+
- type: textarea
|
|
46
|
+
id: screenshots
|
|
47
|
+
attributes:
|
|
48
|
+
label: Скриншоты
|
|
49
|
+
description: Прикрепите скриншоты, если есть такая возможность.
|
|
50
|
+
- type: textarea
|
|
51
|
+
id: reproduce-example
|
|
52
|
+
attributes:
|
|
53
|
+
label: Код, который вызвал ошибку
|
|
54
|
+
description: Вы можете привести листинг кода.
|
|
55
|
+
- type: markdown
|
|
56
|
+
attributes:
|
|
57
|
+
value: |
|
|
58
|
+
Спасибо за то, что помогаете нам стать лучше!
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
name: Publish Workflow / Bump version
|
|
2
|
+
description: It bump version of provided package
|
|
3
|
+
|
|
4
|
+
inputs:
|
|
5
|
+
version:
|
|
6
|
+
description: <newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease
|
|
7
|
+
required: true
|
|
8
|
+
npm_tag:
|
|
9
|
+
description: tag for NPM artifact
|
|
10
|
+
required: false
|
|
11
|
+
|
|
12
|
+
outputs:
|
|
13
|
+
prev_version:
|
|
14
|
+
value: ${{ steps.internal_id_prev_version.outputs.value }}
|
|
15
|
+
next_version:
|
|
16
|
+
value: ${{ steps.internal_id_next_version.outputs.value }}
|
|
17
|
+
|
|
18
|
+
runs:
|
|
19
|
+
using: composite
|
|
20
|
+
steps:
|
|
21
|
+
- name: Saving current version to env
|
|
22
|
+
id: internal_id_prev_version
|
|
23
|
+
run: echo "value=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
|
|
24
|
+
shell: bash
|
|
25
|
+
|
|
26
|
+
- name: Bump version
|
|
27
|
+
if: ${{ !inputs.npm_tag }}
|
|
28
|
+
run: yarn version --new-version "${{ inputs.version }}" --no-commit-hooks
|
|
29
|
+
shell: bash
|
|
30
|
+
|
|
31
|
+
- name: Bump version with npm_tag
|
|
32
|
+
if: ${{ inputs.npm_tag }}
|
|
33
|
+
run: yarn version --new-version "${{ inputs.version }}" --preid ${{ inputs.npm_tag }} --no-commit-hooks
|
|
34
|
+
shell: bash
|
|
35
|
+
|
|
36
|
+
- name: Saving new version to env
|
|
37
|
+
id: internal_id_next_version
|
|
38
|
+
run: echo "value=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
|
|
39
|
+
shell: bash
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
name: Publish Workflow / Complete
|
|
2
|
+
description: It finish publishing
|
|
3
|
+
|
|
4
|
+
inputs:
|
|
5
|
+
branch:
|
|
6
|
+
description: target branch for git push
|
|
7
|
+
required: true
|
|
8
|
+
prev_version:
|
|
9
|
+
description: package's prev version
|
|
10
|
+
required: true
|
|
11
|
+
next_version:
|
|
12
|
+
description: package's next version
|
|
13
|
+
required: true
|
|
14
|
+
npm_tag:
|
|
15
|
+
description: tag for NPM artifact
|
|
16
|
+
required: false
|
|
17
|
+
token:
|
|
18
|
+
description: token for write access to repository
|
|
19
|
+
required: true
|
|
20
|
+
npm_token:
|
|
21
|
+
description: token for publish package to NPM
|
|
22
|
+
|
|
23
|
+
runs:
|
|
24
|
+
using: composite
|
|
25
|
+
steps:
|
|
26
|
+
- name: Create tag
|
|
27
|
+
run: git tag vk-miniapps-deploy@${{ inputs.next_version }}
|
|
28
|
+
shell: bash
|
|
29
|
+
|
|
30
|
+
- name: Pushing changes
|
|
31
|
+
uses: ad-m/github-push-action@master
|
|
32
|
+
with:
|
|
33
|
+
github_token: ${{ inputs.token }}
|
|
34
|
+
branch: ${{ inputs.branch }}
|
|
35
|
+
|
|
36
|
+
- name: Publishing release
|
|
37
|
+
if: ${{ !inputs.npm_tag }}
|
|
38
|
+
run: yarn publish --access public --non-interactive
|
|
39
|
+
env:
|
|
40
|
+
NODE_AUTH_TOKEN: ${{ inputs.npm_token }}
|
|
41
|
+
shell: bash
|
|
42
|
+
|
|
43
|
+
- name: Publishing release with npm_tag
|
|
44
|
+
if: ${{ inputs.npm_tag }}
|
|
45
|
+
run: yarn publish --access public --non-interactive --tag ${{ inputs.npm_tag }}
|
|
46
|
+
env:
|
|
47
|
+
NODE_AUTH_TOKEN: ${{ inputs.npm_token }}
|
|
48
|
+
shell: bash
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
name: Publish Workflow / Setup
|
|
2
|
+
description: It setting up the repository environment for publish
|
|
3
|
+
|
|
4
|
+
runs:
|
|
5
|
+
using: composite
|
|
6
|
+
steps:
|
|
7
|
+
- name: Setup NodeJS
|
|
8
|
+
uses: actions/setup-node@v4
|
|
9
|
+
with:
|
|
10
|
+
node-version: 20
|
|
11
|
+
cache: 'yarn'
|
|
12
|
+
always-auth: true
|
|
13
|
+
registry-url: 'https://registry.npmjs.org'
|
|
14
|
+
|
|
15
|
+
- name: Install dependencies
|
|
16
|
+
run: yarn install --frozen-lockfile --ignore-scripts
|
|
17
|
+
shell: bash
|
|
18
|
+
|
|
19
|
+
- name: Set Git credentials
|
|
20
|
+
run: |
|
|
21
|
+
git config --local user.email "actions@github.com"
|
|
22
|
+
git config --local user.name "GitHub Action"
|
|
23
|
+
shell: bash
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Если ваш pull request еще не готов до конца, отметьте его как draft.
|
|
3
|
+
(см. https://github.blog/2019-02-14-introducing-draft-pull-requests/)
|
|
4
|
+
|
|
5
|
+
Чек лист для отправки нового pull request в репозиторий vk-miniapps-deploy:
|
|
6
|
+
1) 👷♀️ Создавайте небольшие PR. Один PR - одна проблема. Чем меньше изменений, тем проще нам будет его рассмотреть.
|
|
7
|
+
2) ✅ Проверьте, что ваши изменения прошли проверки линтерами.
|
|
8
|
+
3) 📝 В commit messages указывайте, какую именно пользу приносят ваши изменения.
|
|
9
|
+
4) ⚠️ Убедитесь, что ваши изменения не сломают обратную совместимость текущего функционала.
|
|
10
|
+
5) 🧑💻 Протестируйте ваши изменения на поддерживаемых библиотекой операционных системах (Windows/MacOS/Linux).
|
|
11
|
+
|
|
12
|
+
Если этот PR закрывает Issue, то укажите ссылку на него. Используйте доступные ключевые слова (см. https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests).
|
|
13
|
+
|
|
14
|
+
Пример:
|
|
15
|
+
- close #123
|
|
16
|
+
-->
|
|
17
|
+
|
|
18
|
+
## Описание проблемы
|
|
19
|
+
|
|
20
|
+
<!--
|
|
21
|
+
Проблема должна быть описана понятно и полностью, по возможности максимально коротко.
|
|
22
|
+
Для бага - дополнительно приведите описание окружения и шагов воспроизведения.
|
|
23
|
+
Если по данной проблеме создано issue, то добавьте ссылки.
|
|
24
|
+
|
|
25
|
+
Пример:
|
|
26
|
+
- related to #123
|
|
27
|
+
-->
|
|
28
|
+
|
|
29
|
+
## Описание решения
|
|
30
|
+
|
|
31
|
+
<!--
|
|
32
|
+
Напишите подробности о том, что делает PR.
|
|
33
|
+
-->
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
## Способ проверки с шагами
|
|
37
|
+
|
|
38
|
+
<!--
|
|
39
|
+
Опишите то, как тестировался данный pull request.
|
|
40
|
+
По возможности приведите алгоритм действий, расписанный по шагам.
|
|
41
|
+
-->
|
|
42
|
+
|
|
43
|
+
## Обратная совместимость
|
|
44
|
+
|
|
45
|
+
<!--
|
|
46
|
+
Если ваш pull request изменяет поведение текущей реализации, то подробно опишите результат до/после.
|
|
47
|
+
-->
|
|
48
|
+
|
|
49
|
+
## Скриншоты
|
|
50
|
+
|
|
51
|
+
<!--
|
|
52
|
+
Если ваши изменения касаются UI, то прикрепите скриншоты до/после.
|
|
53
|
+
-->
|
|
54
|
+
|
|
55
|
+
<!--
|
|
56
|
+
Спасибо за то, что помогаете нам стать лучше!
|
|
57
|
+
-->
|
|
@@ -3,38 +3,41 @@ name: 'Publish'
|
|
|
3
3
|
on:
|
|
4
4
|
workflow_dispatch:
|
|
5
5
|
inputs:
|
|
6
|
-
|
|
7
|
-
description: 'version
|
|
6
|
+
new_version:
|
|
7
|
+
description: 'version type:'
|
|
8
|
+
type: choice
|
|
9
|
+
default: 'minor'
|
|
10
|
+
options:
|
|
11
|
+
- patch
|
|
12
|
+
- minor
|
|
13
|
+
- major
|
|
8
14
|
required: true
|
|
9
15
|
|
|
16
|
+
run-name: Publish vk-miniapps-deploy ${{ inputs.new_version }}
|
|
17
|
+
|
|
10
18
|
jobs:
|
|
11
19
|
publish:
|
|
12
20
|
runs-on: ubuntu-latest
|
|
13
21
|
steps:
|
|
14
|
-
-
|
|
22
|
+
- name: Checkout
|
|
23
|
+
uses: actions/checkout@v4
|
|
15
24
|
with:
|
|
16
25
|
token: ${{ secrets.DEVTOOLS_GITHUB_TOKEN }}
|
|
17
26
|
|
|
18
|
-
-
|
|
19
|
-
|
|
20
|
-
node-version: 16
|
|
21
|
-
cache: 'yarn'
|
|
22
|
-
always-auth: true
|
|
23
|
-
registry-url: 'https://registry.npmjs.org'
|
|
27
|
+
- name: Setting up the repository environment
|
|
28
|
+
uses: ./.github/actions/setup
|
|
24
29
|
|
|
25
|
-
- name:
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
+
- name: Bump version
|
|
31
|
+
id: updated_versions_info
|
|
32
|
+
uses: ./.github/actions/bump-version
|
|
33
|
+
with:
|
|
34
|
+
version: ${{ github.event.inputs.new_version }}
|
|
30
35
|
|
|
31
|
-
- name:
|
|
32
|
-
uses:
|
|
36
|
+
- name: Complete publish
|
|
37
|
+
uses: ./.github/actions/complete-publish
|
|
33
38
|
with:
|
|
34
|
-
github_token: ${{ secrets.DEVTOOLS_GITHUB_TOKEN }}
|
|
35
39
|
branch: ${{ github.ref }}
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
NODE_AUTH_TOKEN: ${{ secrets.NPMJS_PUBLISH_TOKEN }}
|
|
40
|
+
prev_version: ${{ steps.updated_versions_info.outputs.prev_version }}
|
|
41
|
+
next_version: ${{ steps.updated_versions_info.outputs.next_version }}
|
|
42
|
+
token: ${{ secrets.DEVTOOLS_GITHUB_TOKEN }}
|
|
43
|
+
npm_token: ${{ secrets.NPMJS_PUBLISH_TOKEN }}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
name: 'Publish (pre-release)'
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
inputs:
|
|
6
|
+
new_version:
|
|
7
|
+
description: 'version type (use prerelease for bumping pre-release version):'
|
|
8
|
+
required: true
|
|
9
|
+
type: choice
|
|
10
|
+
default: 'prerelease'
|
|
11
|
+
options:
|
|
12
|
+
- prepatch
|
|
13
|
+
- preminor
|
|
14
|
+
- premajor
|
|
15
|
+
- prerelease
|
|
16
|
+
npm_tag:
|
|
17
|
+
required: true
|
|
18
|
+
description: 'NPM tag:'
|
|
19
|
+
type: choice
|
|
20
|
+
default: 'beta'
|
|
21
|
+
options:
|
|
22
|
+
- alpha
|
|
23
|
+
- beta
|
|
24
|
+
- rc
|
|
25
|
+
custom_version:
|
|
26
|
+
description: 'use syntax x.y.z-beta.0, without "v" (it ignore "version type" parameter):'
|
|
27
|
+
required: false
|
|
28
|
+
|
|
29
|
+
run-name: Publish ${{ inputs.new_version }} vk-miniapps-deploy ${{ inputs.custom_version }}
|
|
30
|
+
|
|
31
|
+
jobs:
|
|
32
|
+
publish:
|
|
33
|
+
runs-on: ubuntu-latest
|
|
34
|
+
steps:
|
|
35
|
+
- name: Checkout
|
|
36
|
+
uses: actions/checkout@v4
|
|
37
|
+
with:
|
|
38
|
+
token: ${{ secrets.DEVTOOLS_GITHUB_TOKEN }}
|
|
39
|
+
|
|
40
|
+
- name: Setting up the repository environment
|
|
41
|
+
uses: ./.github/actions/setup
|
|
42
|
+
|
|
43
|
+
- name: Bump version
|
|
44
|
+
id: updated_versions_info
|
|
45
|
+
uses: ./.github/actions/bump-version
|
|
46
|
+
with:
|
|
47
|
+
version: ${{ github.event.inputs.custom_version || github.event.inputs.new_version }}
|
|
48
|
+
npm_tag: ${{ github.event.inputs.npm_tag }}
|
|
49
|
+
|
|
50
|
+
- name: Complete publish
|
|
51
|
+
uses: ./.github/actions/complete-publish
|
|
52
|
+
with:
|
|
53
|
+
branch: ${{ github.ref }}
|
|
54
|
+
prev_version: ${{ steps.updated_versions_info.outputs.prev_version }}
|
|
55
|
+
next_version: ${{ steps.updated_versions_info.outputs.next_version }}
|
|
56
|
+
npm_tag: ${{ github.event.inputs.npm_tag }}
|
|
57
|
+
token: ${{ secrets.DEVTOOLS_GITHUB_TOKEN }}
|
|
58
|
+
npm_token: ${{ secrets.NPMJS_PUBLISH_TOKEN }}
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
[<img width="134" src="https://
|
|
1
|
+
[<img width="134" src="https://sun9-30.userapi.com/IMLu3sXowImUG-VtL34AqHT4qIUBapkCO0dyhA/bz55lWspvOk.svg">](https://vk.com/services)
|
|
2
2
|
|
|
3
|
-
# VK Mini Apps Deploy [![npm][npm]][npm-url]
|
|
3
|
+
# VK Mini Apps Deploy [![npm][npm]][npm-url]
|
|
4
4
|
|
|
5
5
|
Deploy straight to VK Mini Apps hosting with one simple command.
|
|
6
6
|
|
|
@@ -35,9 +35,9 @@ And now you can run `npm run deploy` to run the `vk-miniapps-deploy` installed i
|
|
|
35
35
|
|
|
36
36
|
## Options
|
|
37
37
|
|
|
38
|
-
To configure `vk-miniapps-deploy` all you need to do is specify a couple of things in your `vk-hosting-config.json`
|
|
38
|
+
To configure `vk-miniapps-deploy` all you need to do is specify a couple of things in your `vk-hosting-config.json`
|
|
39
39
|
|
|
40
|
-
```
|
|
40
|
+
```JSON
|
|
41
41
|
{
|
|
42
42
|
"static_path": "build",
|
|
43
43
|
"app_id": "...",
|
|
@@ -50,10 +50,11 @@ To configure `vk-miniapps-deploy` all you need to do is specify a couple of thin
|
|
|
50
50
|
```
|
|
51
51
|
|
|
52
52
|
## How to use:
|
|
53
|
-
|
|
54
|
-
|
|
53
|
+
|
|
54
|
+
- Make sure that in package.json the key value «homepage» is «./»
|
|
55
|
+
- Copy the example config to the root folder of your application vk-hosting-config.json.example
|
|
55
56
|
and remove the suffix «.example»
|
|
56
|
-
|
|
57
|
+
- Run yarn deploy
|
|
57
58
|
|
|
58
59
|
For your CI, you can use
|
|
59
60
|
|
|
@@ -61,19 +62,20 @@ For your CI, you can use
|
|
|
61
62
|
$ env MINI_APPS_ACCESS_TOKEN=<token> yarn deploy
|
|
62
63
|
```
|
|
63
64
|
|
|
64
|
-
with
|
|
65
|
+
with _user token_ retrieved from vk-miniapps-deploy OR _service token_ of deployable application
|
|
65
66
|
|
|
66
|
-
There are two values to specify MINI_APPS_ENVIRONMENT: `production` or `dev`.
|
|
67
|
+
There are two values to specify MINI_APPS_ENVIRONMENT: `production` or `dev`.
|
|
67
68
|
All production builds will be also deployed on dev environment.
|
|
68
69
|
|
|
69
70
|
If you grep URL paths, you can use environment variable `CI_URLS = true`.
|
|
70
71
|
|
|
71
72
|
## Troubleshooting:
|
|
73
|
+
|
|
72
74
|
If you get an error `User authorization failed: invalid session`, try this comand:
|
|
75
|
+
|
|
73
76
|
```bash
|
|
74
77
|
rm ~/.config/configstore/@vkontakte/vk-miniapps-deploy.json
|
|
75
78
|
```
|
|
79
|
+
|
|
76
80
|
[npm]: https://img.shields.io/npm/v/@vkontakte/vk-miniapps-deploy.svg
|
|
77
81
|
[npm-url]: https://npmjs.com/package/@vkontakte/vk-miniapps-deploy
|
|
78
|
-
[deps]: https://img.shields.io/david/vkcom/vk-miniapps-deploy.svg
|
|
79
|
-
[deps-url]: https://david-dm.org/vkcom/vk-miniapps-deploy
|
package/index.js
CHANGED
|
@@ -7,7 +7,6 @@ const { zip } = require('zip-a-folder');
|
|
|
7
7
|
const fs = require('fs-extra');
|
|
8
8
|
const FormData = require('form-data');
|
|
9
9
|
const Configstore = require('configstore');
|
|
10
|
-
const glob = require('glob');
|
|
11
10
|
const vault = new Configstore(packageJson.name, {});
|
|
12
11
|
|
|
13
12
|
var configJSON = require('require-module')('./vk-hosting-config.json');
|
|
@@ -415,12 +414,6 @@ async function run(cfg) {
|
|
|
415
414
|
const bundleFile = cfg.bundleFile || './build.zip';
|
|
416
415
|
|
|
417
416
|
if (!cfg.bundleFile) {
|
|
418
|
-
const excludedFiles = await glob.sync('./' + staticPath + '/**/*.txt');
|
|
419
|
-
|
|
420
|
-
await excludedFiles.forEach((file) => {
|
|
421
|
-
fs.removeSync(file);
|
|
422
|
-
});
|
|
423
|
-
|
|
424
417
|
if (await fs.pathExists(bundleFile)) {
|
|
425
418
|
fs.removeSync(bundleFile)
|
|
426
419
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vkontakte/vk-miniapps-deploy",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.8-rc.0",
|
|
4
4
|
"description": "Deploy to VK Mini Apps hosting with one simple command",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -38,7 +38,6 @@
|
|
|
38
38
|
"configstore": "^5.0.0",
|
|
39
39
|
"form-data": "^3.0.0",
|
|
40
40
|
"fs-extra": "^8.0.1",
|
|
41
|
-
"glob": "^7.1.6",
|
|
42
41
|
"node-fetch": "^2.6.0",
|
|
43
42
|
"prompts": "^2.1.0",
|
|
44
43
|
"require-module": "^0.1.0",
|