@kitschpatrol/repo-config 4.7.0 → 4.7.2
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.
|
@@ -50,12 +50,12 @@ jobs:
|
|
|
50
50
|
- name: Release Notes
|
|
51
51
|
if: env.IS_VALID_COMMIT == 'true'
|
|
52
52
|
id: release-notes
|
|
53
|
-
uses:
|
|
53
|
+
uses: kitschpatrol/github-action-release-changelog@v2
|
|
54
54
|
|
|
55
55
|
- name: Release
|
|
56
56
|
if: env.IS_VALID_COMMIT == 'true'
|
|
57
57
|
id: release
|
|
58
|
-
uses:
|
|
58
|
+
uses: kitschpatrol/github-action-release@v2
|
|
59
59
|
with:
|
|
60
60
|
token: ${{ env.ACCESS_TOKEN }}
|
|
61
61
|
draft: false
|
|
@@ -2,6 +2,8 @@ name: Overwrite GitHub repo metadata with info from package.json
|
|
|
2
2
|
on:
|
|
3
3
|
push:
|
|
4
4
|
branches: [main]
|
|
5
|
+
workflow_dispatch:
|
|
6
|
+
|
|
5
7
|
jobs:
|
|
6
8
|
build:
|
|
7
9
|
name: Sync Metadata
|
|
@@ -39,7 +41,7 @@ jobs:
|
|
|
39
41
|
|
|
40
42
|
- name: Sync Package info to GitHub
|
|
41
43
|
if: env.IS_VALID_TOKEN == 'true' && env.HAS_PACKAGE == 'true'
|
|
42
|
-
uses:
|
|
44
|
+
uses: kitschpatrol/github-action-repo-sync@v2
|
|
43
45
|
with:
|
|
44
46
|
TYPE: npm
|
|
45
47
|
PATH: package.json
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -25,16 +25,14 @@ It's a `pnpm`-flavored shared config with some essential files for a fresh repo.
|
|
|
25
25
|
|
|
26
26
|
This includes the following:
|
|
27
27
|
|
|
28
|
-
- [`.npmrc`](https://pnpm.io/npmrc) with hoisting patterns for
|
|
28
|
+
- [`.npmrc`](https://pnpm.io/npmrc) with hoisting patterns for `shared-config` tool access
|
|
29
29
|
- `.gitignore` with typical patterns
|
|
30
30
|
- `.vscode` extension recommendations (additional settings and recommendations come from other `shared-config` packages)
|
|
31
31
|
- `.github` folder with workflows:
|
|
32
|
-
- `github-release.yml` Automates turning turning vX.X.X tags on main into GitHub releases
|
|
32
|
+
- `github-release.yml` Automates turning turning vX.X.X tags on main into GitHub releases with changelogs
|
|
33
33
|
- `sync-metadata.yml` Populates GitHub repo metadata from package.json
|
|
34
34
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
It's critical that it is applied _before_ any other `@kitschpatrol/shared-config` packages are installed.
|
|
35
|
+
In order to work around some hoisting issues related to plugin resolution in the other `@kitschpatrol/shared-config` packages, it's critical that it is applied _before_ any other `@kitschpatrol/shared-config` packages are installed.
|
|
38
36
|
|
|
39
37
|
**See [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config) for the recommended single-package approach.**
|
|
40
38
|
|
|
@@ -86,6 +84,16 @@ If you want releases to come from your account instead of `github_actions`, then
|
|
|
86
84
|
|
|
87
85
|
2. Add the token as a secret to the repository under the key `PERSONAL_ACCESS_TOKEN`.
|
|
88
86
|
|
|
87
|
+
### GitHub Actions
|
|
88
|
+
|
|
89
|
+
Note: Action dependencies have been forked.
|
|
90
|
+
|
|
91
|
+
| Original | Fork | Modifications |
|
|
92
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ------------- |
|
|
93
|
+
| [bullrich/generate-release-changelog](https://github.com/bullrich/generate-release-changelog) | [kitschpatrol/github-action-release-changelog](https://github.com/kitschpatrol/github-action-release-changelog) | ❌ |
|
|
94
|
+
| [softprops/action-gh-release](https://github.com/softprops/action-gh-release) | [kitschpatrol/github-action-release](https://github.com/kitschpatrol/github-action-release) | ❌ |
|
|
95
|
+
| [kbrashears5/github-action-repo-sync](https://github.com/kbrashears5/github-action-repo-sync) | [kitschpatrol/github-action-repo-sync](https://github.com/kitschpatrol/github-action-repo-sync) | ✅ |
|
|
96
|
+
|
|
89
97
|
## Usage
|
|
90
98
|
|
|
91
99
|
### CLI
|
|
@@ -102,12 +110,12 @@ Usage:
|
|
|
102
110
|
repo-config [<file|glob> ...]
|
|
103
111
|
```
|
|
104
112
|
|
|
105
|
-
| Option
|
|
106
|
-
|
|
|
107
|
-
| `--init` |
|
|
108
|
-
| `--print-config` |
|
|
109
|
-
| `--help` |
|
|
110
|
-
| `--version` |
|
|
113
|
+
| Option | Argument | Description |
|
|
114
|
+
| ------------------------ | -------- | ---------------------------------------------------------------- |
|
|
115
|
+
| `--init`<br>`-i` | | Initialize by copying starter config files to your project root. |
|
|
116
|
+
| `--print-config`<br>`-p` | `<path>` | Print the effective configuration at a certain path. |
|
|
117
|
+
| `--help`<br>`-h` | | Print this help info. |
|
|
118
|
+
| `--version`<br>`-v` | | Print the package version. |
|
|
111
119
|
|
|
112
120
|
<!-- /cli-help -->
|
|
113
121
|
|