@kunalnagarco/jquery-peek-a-bar 5.0.0 → 5.0.1
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 +31 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# @kunalnagarco/jquery-peek-a-bar
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@kunalnagarco/jquery-peek-a-bar)
|
|
4
|
+
[](https://github.com/kunalnagarco/jquery.peekABar/actions/workflows/ci.yml)
|
|
5
|
+
[](./LICENSE)
|
|
4
6
|
|
|
5
7
|
A jQuery plugin for a notification bar with customization options.
|
|
6
8
|
|
|
@@ -156,6 +158,34 @@ bar.show({
|
|
|
156
158
|
});
|
|
157
159
|
```
|
|
158
160
|
|
|
161
|
+
## Development
|
|
162
|
+
|
|
163
|
+
This project uses [Yarn 4](https://yarnpkg.com/), pinned via the `packageManager`
|
|
164
|
+
field and managed by [Corepack](https://nodejs.org/api/corepack.html) (bundled
|
|
165
|
+
with Node.js ≥ 16.9). Enable Corepack once, then install and build:
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
corepack enable # activates the pinned Yarn version automatically
|
|
169
|
+
yarn install --immutable
|
|
170
|
+
yarn build
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
The Node version is pinned in `.nvmrc`.
|
|
174
|
+
|
|
175
|
+
### Releasing
|
|
176
|
+
|
|
177
|
+
Releases are automated by [semantic-release](https://semantic-release.gitbook.io/)
|
|
178
|
+
on every push to `master` (see `.github/workflows/cd.yml`). Version bumps,
|
|
179
|
+
changelog entries, the GitHub release, and the npm publish all happen in CI —
|
|
180
|
+
never publish from a local machine.
|
|
181
|
+
|
|
182
|
+
npm publishing uses **OIDC [trusted publishing](https://docs.npmjs.com/trusted-publishers)**
|
|
183
|
+
rather than a long-lived `NPM_TOKEN`, so no npm secret is stored in the repo and
|
|
184
|
+
every release is published with [provenance](https://docs.npmjs.com/generating-provenance-statements)
|
|
185
|
+
automatically. This requires a one-time setup on npmjs.com: under the package's
|
|
186
|
+
**Settings → Trusted Publisher**, add a GitHub Actions publisher for the
|
|
187
|
+
`kunalnagarco/jquery.peekABar` repository and the `cd.yml` workflow.
|
|
188
|
+
|
|
159
189
|
## Browser Support
|
|
160
190
|
|
|
161
191
|
All modern browsers are supported. IE11 and below are **not** supported as of v5.0.0.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kunalnagarco/jquery-peek-a-bar",
|
|
3
|
-
"version": "5.0.
|
|
3
|
+
"version": "5.0.1",
|
|
4
4
|
"description": "A jQuery plugin for a notification bar with a lot of customization options.",
|
|
5
5
|
"main": "dist/js/jquery.peekabar.js",
|
|
6
6
|
"files": [
|
|
@@ -40,5 +40,6 @@
|
|
|
40
40
|
},
|
|
41
41
|
"publishConfig": {
|
|
42
42
|
"access": "public"
|
|
43
|
-
}
|
|
43
|
+
},
|
|
44
|
+
"packageManager": "yarn@4.17.1+sha512.ccbfabf7d7b6b32075088be9386fb9a2e00bb6887ef07fa56effabc890a56d53da1ccc4128d62db245fcbd3961b236d75335bdf7d5320ed6eafb7588b7ad4697"
|
|
44
45
|
}
|