newspack-scripts 5.0.0 → 5.1.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 +12 -10
- package/config/stylelint.config.js +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -73,7 +73,7 @@ The following assumes that CI will run:
|
|
|
73
73
|
### Hotfix release flow
|
|
74
74
|
|
|
75
75
|
1. Create a new `hotfix/*` branch off the `release` branch
|
|
76
|
-
1. Push the branch to Github, so the CI can process it – _don't create a PR just yet
|
|
76
|
+
1. Push the branch to Github, so the CI can process it – _don't create a PR just yet!\*_
|
|
77
77
|
1. A new "hotfix" pre-release (e.g. `1.2.0-hotfix.1`) will be published
|
|
78
78
|
1. Merge the hotfix branch into `release` to create a release
|
|
79
79
|
1. `alpha` & `master` branches will be updated with the changes from the `release` branch
|
|
@@ -91,13 +91,13 @@ This package exposes a couple of configuration files.
|
|
|
91
91
|
The `webpack.config.js` file should use this package's config-extending function:
|
|
92
92
|
|
|
93
93
|
```js
|
|
94
|
-
const getBaseWebpackConfig = require(
|
|
94
|
+
const getBaseWebpackConfig = require("newspack-scripts/config/getWebpackConfig");
|
|
95
95
|
|
|
96
96
|
const webpackConfig = getBaseWebpackConfig(
|
|
97
97
|
{ WP: true },
|
|
98
98
|
{
|
|
99
99
|
entry: {
|
|
100
|
-
|
|
100
|
+
"some-script": "./src/some-script.js",
|
|
101
101
|
},
|
|
102
102
|
}
|
|
103
103
|
);
|
|
@@ -110,10 +110,10 @@ module.exports = webpackConfig;
|
|
|
110
110
|
A basic `babel.config.js`:
|
|
111
111
|
|
|
112
112
|
```js
|
|
113
|
-
module.exports = api => {
|
|
114
|
-
api.cache(
|
|
113
|
+
module.exports = (api) => {
|
|
114
|
+
api.cache(true);
|
|
115
115
|
return {
|
|
116
|
-
extends:
|
|
116
|
+
extends: "newspack-scripts/config/babel.config.js",
|
|
117
117
|
};
|
|
118
118
|
};
|
|
119
119
|
```
|
|
@@ -123,10 +123,10 @@ module.exports = api => {
|
|
|
123
123
|
Because of eslint's [issue](https://github.com/eslint/eslint/issues/3458) with resolving dependencies of extended configurations, a patch has to be used to use this config in a stand-alone fashion: install `@rushstack/eslint-patch` and set up the `.eslintrc.js` like so:
|
|
124
124
|
|
|
125
125
|
```js
|
|
126
|
-
require(
|
|
126
|
+
require("@rushstack/eslint-patch/modern-module-resolution");
|
|
127
127
|
|
|
128
128
|
module.exports = {
|
|
129
|
-
extends: [
|
|
129
|
+
extends: ["./node_modules/newspack-scripts/config/eslintrc.js"],
|
|
130
130
|
// Additional options…
|
|
131
131
|
};
|
|
132
132
|
```
|
|
@@ -155,7 +155,7 @@ This repository hosts a [CircleCI Orb](https://circleci.com/docs/2.0/orb-intro),
|
|
|
155
155
|
version: 2.1
|
|
156
156
|
|
|
157
157
|
orbs:
|
|
158
|
-
newspack:
|
|
158
|
+
newspack: newspack/newspack@1.0.0
|
|
159
159
|
|
|
160
160
|
workflows:
|
|
161
161
|
version: 2
|
|
@@ -170,9 +170,11 @@ To update the Orb, use [CircleCI's CLI's](https://circleci.com/docs/2.0/local-cl
|
|
|
170
170
|
|
|
171
171
|
```bash
|
|
172
172
|
# Replace the `version` at the end (e.g. 1.0.1)
|
|
173
|
-
circleci orb pack src/ > orb.yml && circleci orb publish orb.yml
|
|
173
|
+
circleci orb pack src/ > orb.yml && circleci orb publish orb.yml newspack/newspack@version
|
|
174
174
|
```
|
|
175
175
|
|
|
176
|
+
Note that before the first time updating you'll need to set the API key for CircleCI CLI by running `$ circleci setup`.
|
|
177
|
+
|
|
176
178
|
---
|
|
177
179
|
|
|
178
180
|
## Misc
|