@form8ion/github-workflows-core 1.0.0-alpha.3 → 2.0.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/README.md +28 -0
- package/package.json +32 -32
package/README.md
CHANGED
|
@@ -64,6 +64,34 @@ import {
|
|
|
64
64
|
})();
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
+
### API
|
|
68
|
+
|
|
69
|
+
#### `scaffoldCheckoutStep`
|
|
70
|
+
|
|
71
|
+
Scaffolder to define the details for a step to check out the project in a
|
|
72
|
+
GitHub workflow
|
|
73
|
+
|
|
74
|
+
#### `scaffoldNodeSetupStep`
|
|
75
|
+
|
|
76
|
+
Scaffolder to define the details for a step to set up a node.js environment in
|
|
77
|
+
a GitHub workflow
|
|
78
|
+
|
|
79
|
+
Takes a single options object as an argument, containing:
|
|
80
|
+
|
|
81
|
+
##### `versionDeterminedBy` __string__ (_required_)
|
|
82
|
+
|
|
83
|
+
Source of node version for use in the configured step. Valid options are `nvmrc`
|
|
84
|
+
or `matrix`
|
|
85
|
+
|
|
86
|
+
#### `scaffoldDependencyInstallationStep`
|
|
87
|
+
|
|
88
|
+
Scaffolder to define the details for a step to install dependencies in a GitHub
|
|
89
|
+
workflow
|
|
90
|
+
|
|
91
|
+
#### `scaffoldVerificationStep`
|
|
92
|
+
|
|
93
|
+
Scaffolder to define the details for a step to execute verification
|
|
94
|
+
|
|
67
95
|
## Contributing
|
|
68
96
|
|
|
69
97
|
<!--contribution-badges start -->
|
package/package.json
CHANGED
|
@@ -2,30 +2,23 @@
|
|
|
2
2
|
"name": "@form8ion/github-workflows-core",
|
|
3
3
|
"description": "core functionality for form8ion plugins that manage github workflows",
|
|
4
4
|
"license": "MIT",
|
|
5
|
+
"version": "2.0.0",
|
|
5
6
|
"type": "commonjs",
|
|
6
|
-
"version": "1.0.0-alpha.3",
|
|
7
7
|
"engines": {
|
|
8
|
-
"node": "^14.
|
|
9
|
-
},
|
|
10
|
-
"files": [
|
|
11
|
-
"example.js",
|
|
12
|
-
"lib/"
|
|
13
|
-
],
|
|
14
|
-
"publishConfig": {
|
|
15
|
-
"access": "public"
|
|
8
|
+
"node": "^14.17.0 || ^16.13.0 || >=18"
|
|
16
9
|
},
|
|
10
|
+
"author": "Matt Travi <npm@travi.org> (https://matt.travi.org)",
|
|
11
|
+
"repository": "form8ion/github-workflows-core",
|
|
12
|
+
"bugs": "https://github.com/form8ion/github-workflows-core/issues",
|
|
13
|
+
"homepage": "https://npm.im/@form8ion/github-workflows-core",
|
|
17
14
|
"runkitExampleFilename": "./example.js",
|
|
18
|
-
"main": "lib/index.js",
|
|
19
|
-
"module": "lib/index.mjs",
|
|
20
15
|
"exports": {
|
|
21
16
|
"require": "./lib/index.js",
|
|
22
17
|
"import": "./lib/index.mjs"
|
|
23
18
|
},
|
|
19
|
+
"main": "lib/index.js",
|
|
20
|
+
"module": "lib/index.mjs",
|
|
24
21
|
"sideEffects": false,
|
|
25
|
-
"repository": "form8ion/github-workflows-core",
|
|
26
|
-
"bugs": "https://github.com/form8ion/github-workflows-core/issues",
|
|
27
|
-
"homepage": "https://npm.im/@form8ion/github-workflows-core",
|
|
28
|
-
"author": "Matt Travi <npm@travi.org> (https://matt.travi.org)",
|
|
29
22
|
"scripts": {
|
|
30
23
|
"test": "npm-run-all --print-label build --parallel lint:* --parallel test:*",
|
|
31
24
|
"pretest:integration:base": "preview",
|
|
@@ -55,37 +48,44 @@
|
|
|
55
48
|
"lint:peer": "npm ls >/dev/null",
|
|
56
49
|
"lint:engines": "ls-engines"
|
|
57
50
|
},
|
|
51
|
+
"files": [
|
|
52
|
+
"example.js",
|
|
53
|
+
"lib/"
|
|
54
|
+
],
|
|
55
|
+
"publishConfig": {
|
|
56
|
+
"access": "public"
|
|
57
|
+
},
|
|
58
58
|
"devDependencies": {
|
|
59
|
-
"@babel/register": "7.
|
|
60
|
-
"@cucumber/cucumber": "8.
|
|
61
|
-
"@form8ion/babel-preset": "1.6.
|
|
62
|
-
"@form8ion/commitlint-config": "1.0.
|
|
63
|
-
"@form8ion/eslint-config": "5.0.
|
|
59
|
+
"@babel/register": "7.18.9",
|
|
60
|
+
"@cucumber/cucumber": "8.7.0",
|
|
61
|
+
"@form8ion/babel-preset": "1.6.99",
|
|
62
|
+
"@form8ion/commitlint-config": "1.0.38",
|
|
63
|
+
"@form8ion/eslint-config": "5.0.12",
|
|
64
64
|
"@form8ion/eslint-config-cucumber": "1.4.1",
|
|
65
|
-
"@form8ion/eslint-config-mocha": "2.0.
|
|
66
|
-
"@form8ion/remark-lint-preset": "4.0.
|
|
67
|
-
"@rollup/plugin-babel": "
|
|
68
|
-
"@travi/any": "2.
|
|
65
|
+
"@form8ion/eslint-config-mocha": "2.0.3",
|
|
66
|
+
"@form8ion/remark-lint-preset": "4.0.2",
|
|
67
|
+
"@rollup/plugin-babel": "6.0.2",
|
|
68
|
+
"@travi/any": "2.1.6",
|
|
69
69
|
"babel-plugin-istanbul": "6.1.1",
|
|
70
70
|
"ban-sensitive-files": "1.9.18",
|
|
71
|
-
"c8": "7.
|
|
71
|
+
"c8": "7.12.0",
|
|
72
72
|
"chai": "4.3.6",
|
|
73
73
|
"cross-env": "7.0.3",
|
|
74
74
|
"cz-conventional-changelog": "3.3.0",
|
|
75
75
|
"gherkin-lint": "4.2.2",
|
|
76
76
|
"husky": "8.0.1",
|
|
77
|
-
"lockfile-lint": "4.
|
|
78
|
-
"ls-engines": "0.
|
|
79
|
-
"mocha": "10.
|
|
80
|
-
"mock-fs": "5.1.
|
|
77
|
+
"lockfile-lint": "4.9.6",
|
|
78
|
+
"ls-engines": "0.7.0",
|
|
79
|
+
"mocha": "10.1.0",
|
|
80
|
+
"mock-fs": "5.1.4",
|
|
81
81
|
"npm-run-all": "4.1.5",
|
|
82
82
|
"package-preview": "4.0.0",
|
|
83
|
-
"remark-cli": "
|
|
83
|
+
"remark-cli": "11.0.0",
|
|
84
84
|
"remark-toc": "8.0.1",
|
|
85
85
|
"remark-usage": "10.0.1",
|
|
86
86
|
"rimraf": "3.0.2",
|
|
87
|
-
"rollup": "2.
|
|
87
|
+
"rollup": "2.79.1",
|
|
88
88
|
"rollup-plugin-auto-external": "2.0.0",
|
|
89
|
-
"sinon": "14.0.
|
|
89
|
+
"sinon": "14.0.1"
|
|
90
90
|
}
|
|
91
91
|
}
|