github-action-readme-generator 1.12.8 → 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.
Files changed (7) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +14 -10
  3. package/action.yml +3 -1
  4. package/dist/bin/index.js +759 -529
  5. package/dist/mjs/index.d.ts +2 -3
  6. package/dist/mjs/index.js +118 -22
  7. package/package.json +6 -5
package/CHANGELOG.md CHANGED
@@ -1,3 +1,20 @@
1
+ ## [2.0.0](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.12.9...v2.0.0) (2026-09-25)
2
+
3
+ ### ⚠ BREAKING CHANGES
4
+
5
+ * **prettier:** format only the spans between section markers (#690)
6
+
7
+ ### Bug Fixes
8
+
9
+ * **prettier:** format only the spans between section markers ([#690](https://github.com/bitflight-devops/github-action-readme-generator/issues/690)) ([f48b40d](https://github.com/bitflight-devops/github-action-readme-generator/commit/f48b40d7f03ec632f4c10957c7a2130f2d20cc7f))
10
+
11
+ ## [1.12.9](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.12.8...v1.12.9) (2026-09-22)
12
+
13
+
14
+ ### Bug Fixes
15
+
16
+ * **usage:** comment continuation lines of a multi-line input default ([#687](https://github.com/bitflight-devops/github-action-readme-generator/issues/687)) ([552b645](https://github.com/bitflight-devops/github-action-readme-generator/commit/552b6454837940ecdb5ef53c94e86b7016f19a78))
17
+
1
18
  ## [1.12.8](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.12.7...v1.12.8) (2026-08-17)
2
19
 
3
20
 
package/README.md CHANGED
@@ -70,11 +70,12 @@ sections whose markers you added are touched.
70
70
  **Text outside the markers is yours and stays yours.** The tool replaces only
71
71
  the span between a `start`/`end` pair.
72
72
 
73
- **With `pretty` on (the default), the whole file is reformatted.** That is the
74
- one exception to the rule above: prettier runs over the entire README, so a
75
- first run on a file that was not already prettier-formatted will also reflow
76
- prose the tool did not generate. Run with `--pretty=false` if you would rather
77
- it left your formatting alone.
73
+ **`pretty` formats the generated sections and nothing else.** With it on (the
74
+ default) prettier runs over each replaced span on its own — it pads the tables
75
+ it generated and tidies the usage block, and it never reaches your prose. A
76
+ first run on a file that was not already prettier-formatted changes the marker
77
+ sections and no other line. Run with `--pretty=false` to have the generated
78
+ sections written exactly as the tool composed them.
78
79
 
79
80
  **Only yaml and markdown code blocks are reformatted; every other fence is left
80
81
  as you wrote it.** Formatting needs a prettier plugin per language, and this tool
@@ -105,7 +106,7 @@ apply to the CLI and the Action alike.
105
106
  | --paths:readme, --readme | Path to the README file | `README.md` |
106
107
  | --owner | The GitHub Action repository owner | autodetected |
107
108
  | --repo | The GitHub Action repository name | autodetected |
108
- | --prettier, --pretty | Format the markdown using prettier formatter | `true` |
109
+ | --prettier, --pretty | Format the generated sections using the prettier formatter | `true` |
109
110
  | --versioning:enabled, --versioning | Enable the update of the usage version to match the latest version | `true` |
110
111
  | --versioning:source, --version_source | How to detect the version: `git-tag`, `git-branch`, `git-sha`, `package-json`, `explicit` | `git-tag` |
111
112
  | --versioning:override, --version_override, --setversion | Set a specific version to display in the README.md | unset |
@@ -118,7 +119,8 @@ apply to the CLI and the Action alike.
118
119
  | --save | Save this config to `.ghadocs.json` | `false` |
119
120
  | --debug_config, --debug_nconf | Print out the resolved config with all values, then continue | off |
120
121
 
121
- To turn formatting off, pass the flag explicitly:
122
+ To write the generated sections exactly as the tool composed them, pass the flag
123
+ explicitly:
122
124
 
123
125
  ```sh
124
126
  npx github-action-readme-generator --pretty=false
@@ -267,7 +269,7 @@ value replaced by `***REDACTED***`. Keys whose names look sensitive (`auth`,
267
269
  <!-- start usage -->
268
270
 
269
271
  ```yaml
270
- - uses: bitflight-devops/github-action-readme-generator@v1.12.7
272
+ - uses: bitflight-devops/github-action-readme-generator@v1.12.9
271
273
  with:
272
274
  # Description: The absolute or relative path to the `action.yml` file to read in
273
275
  # from.
@@ -297,7 +299,9 @@ value replaced by `***REDACTED***`. Keys whose names look sensitive (`auth`,
297
299
  # Default: false
298
300
  save: ""
299
301
 
300
- # Description: Use `prettier` to pretty print the new README.md file
302
+ # Description: Use `prettier` to pretty print the sections this tool generates.
303
+ # Only the content between a section's start and end markers is formatted. The
304
+ # rest of the README.md file is left byte for byte as it was.
301
305
  #
302
306
  # Default: true
303
307
  pretty: ""
@@ -389,7 +393,7 @@ value replaced by `***REDACTED***`. Keys whose names look sensitive (`auth`,
389
393
  | <b><code>owner</code></b> | The GitHub Action repository owner, this field is autodetected by default.<br />Example: <code>bitflight-devops</code> or <code>your-gh-username</code> | | **false** |
390
394
  | <b><code>repo</code></b> | The GitHub Action repository name, this field is autodetected by default.<br />Example: <code>github-action-readme-generator</code> | | **false** |
391
395
  | <b><code>save</code></b> | Save the provided values in a <code>.ghadocs.json</code> file.<br />This will update any existing <code>.ghadocs.json</code> file that is in place. | <code>false</code> | **false** |
392
- | <b><code>pretty</code></b> | Use <code>prettier</code> to pretty print the new README.md file | <code>true</code> | **false** |
396
+ | <b><code>pretty</code></b> | Use <code>prettier</code> to pretty print the sections this tool generates.<br />Only the content between a section's start and end markers is formatted.<br />The rest of the README.md file is left byte for byte as it was. | <code>true</code> | **false** |
393
397
  | <b><code>versioning_enabled</code></b> | Enable the update of the usage version in the <code>uses:</code> example.<br />The version comes from whichever <code>version_source</code> selects. The default, <code>git-tag</code>, uses the latest git tag, and falls back to <code>package.json</code>, then to <code>$npm_package_version</code>, then to <code>0.0.0</code> when no tag is found — a shallow or tagless checkout takes that path.<br />Output if your action repo is <code>reviewdog/action-eslint</code> and the latest tag is <code>v1.0.1</code>:<br /><code>uses: reviewdog/action-eslint@v1.0.1</code> | <code>true</code> | **false** |
394
398
  | <b><code>version_override</code></b> | Set a specific version to display in the README.md, maybe you want to use a major or minor version | | **false** |
395
399
  | <b><code>version_prefix</code></b> | Prefix the version with this value, if it isn't already prefixed | <code>v</code> | **false** |
package/action.yml CHANGED
@@ -36,7 +36,9 @@ inputs:
36
36
  default: false
37
37
  pretty:
38
38
  description: |
39
- Use `prettier` to pretty print the new README.md file
39
+ Use `prettier` to pretty print the sections this tool generates.
40
+ Only the content between a section's start and end markers is formatted.
41
+ The rest of the README.md file is left byte for byte as it was.
40
42
  required: false
41
43
  default: 'true'
42
44
  versioning_enabled: