@adamhl8/configs 0.24.0 → 0.24.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.
Files changed (2) hide show
  1. package/README.md +40 -0
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -55,6 +55,46 @@ const config = vitestConfig({ ... })
55
55
  export default defineConfig(config)
56
56
  ```
57
57
 
58
+ ## GitHub Actions
59
+
60
+ This repo hosts two reusable workflows you can call from other projects instead of copy/pasting them. The calling project must use `nub` and define `lint` / `bundle` / `bump-deps` scripts and a commitlint config (e.g. via these configs).
61
+
62
+ - `ci.yml`: runs `bundle` (build + lint) on pushes/PRs and lints commit messages with commitlint
63
+ - `update-deps.yml`: weekly `bump-deps` run that opens a dependency-update PR
64
+
65
+ Reference `@main` for latest, or pin to a release tag or commit SHA to update deliberately.
66
+
67
+ ### CI
68
+
69
+ ```yaml
70
+ # .github/workflows/ci.yml
71
+ name: CI
72
+ on:
73
+ push:
74
+ branches: [main]
75
+ pull_request:
76
+ jobs:
77
+ ci:
78
+ uses: adamhl8/configs/.github/workflows/ci.yml@main
79
+ ```
80
+
81
+ ### Update dependencies
82
+
83
+ Requires a `CI_TOKEN` repo secret (a PAT with `contents` and `pull-requests` write) so the opened PR triggers the CI workflow.
84
+
85
+ ```yaml
86
+ # .github/workflows/update-deps.yml
87
+ name: Update dependencies
88
+ on:
89
+ schedule:
90
+ - cron: "0 13 * * 5" # Fridays, 13:00 UTC
91
+ workflow_dispatch: {}
92
+ jobs:
93
+ update-deps:
94
+ uses: adamhl8/configs/.github/workflows/update-deps.yml@main
95
+ secrets: inherit
96
+ ```
97
+
58
98
  ## Notes
59
99
 
60
100
  The `prepare` script looks like: `"prepare": "lefthook install && nub ./patch-knip.ts && tsdown"`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adamhl8/configs",
3
- "version": "0.24.0",
3
+ "version": "0.24.1",
4
4
  "homepage": "https://github.com/adamhl8/configs",
5
5
  "bugs": {
6
6
  "url": "https://github.com/adamhl8/configs/issues"
@@ -56,8 +56,8 @@
56
56
  "@types/node": "^26.0.1",
57
57
  "knip": "^6.23.0",
58
58
  "markdown-toc": "^1.2.0",
59
- "oxfmt": "^0.56.0",
60
- "oxlint": "^1.71.0",
59
+ "oxfmt": "^0.57.0",
60
+ "oxlint": "^1.72.0",
61
61
  "oxlint-tsgolint": "^0.23.0",
62
62
  "publint": "^0.3.21",
63
63
  "release-it": "^20.2.1",