github-action-readme-generator 1.2.3 → 1.2.4
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.example.md +2 -2
- package/README.md +18 -18
- package/package.json +1 -1
package/README.example.md
CHANGED
package/README.md
CHANGED
|
@@ -58,7 +58,7 @@ or use none, and instead use a `.ghadocs.json` file.
|
|
|
58
58
|
|
|
59
59
|
## Configuration
|
|
60
60
|
|
|
61
|
-
### Example `.
|
|
61
|
+
### Example `.ghadocs.json` with all possible values
|
|
62
62
|
|
|
63
63
|
```json
|
|
64
64
|
{
|
|
@@ -90,7 +90,7 @@ or use none, and instead use a `.ghadocs.json` file.
|
|
|
90
90
|
- [ ] Add a markdown `contents` menu section to the generator
|
|
91
91
|
- [ ] Allow for using a separate template for generating the readme file
|
|
92
92
|
- [ ] Add section to embed other markdown files, or directories by path, so that documentation can be organized in the file system. <br />
|
|
93
|
-
i.e: `<!-- start [.github/
|
|
93
|
+
i.e: `<!-- start [.github/ghadocs/examples/] -->` and `<!-- end [.github/ghadocs/examples/] -->`
|
|
94
94
|
|
|
95
95
|
<!-- start contents -->
|
|
96
96
|
<!-- end contents -->
|
|
@@ -118,7 +118,7 @@ or use none, and instead use a `.ghadocs.json` file.
|
|
|
118
118
|
repo: ""
|
|
119
119
|
|
|
120
120
|
# Save the provided values in a `.ghadocs.json` file. This will update any
|
|
121
|
-
# existing `.
|
|
121
|
+
# existing `.ghadocs.json` file that is in place.
|
|
122
122
|
save: ""
|
|
123
123
|
|
|
124
124
|
# Use `prettier` to pretty print the new README.md file
|
|
@@ -150,22 +150,22 @@ or use none, and instead use a `.ghadocs.json` file.
|
|
|
150
150
|
|
|
151
151
|
<!-- start inputs -->
|
|
152
152
|
|
|
153
|
-
| **Input** | **Description**
|
|
154
|
-
| ------------------------------- |
|
|
155
|
-
| **`action`** | The absolute or relative path to the `action.yml` file to read in from.
|
|
156
|
-
| **`readme`** | The absolute or relative path to the markdown output file that contains the formatting tokens within it.
|
|
157
|
-
| **`owner`** | The GitHub Action repository owner. i.e: `bitflight-devops`|`your-gh-username`
|
|
158
|
-
| **`repo`** | The GitHub Action repository name. i.e: `github-action-readme-generator`
|
|
159
|
-
| **`save`** | Save the provided values in a `.ghadocs.json` file. This will update any existing `.
|
|
160
|
-
| **`pretty`** | Use `prettier` to pretty print the new README.md file
|
|
161
|
-
| **`versioning_enabled`** | Enable the update of the usage version to match the latest version in the `package.json` file
|
|
162
|
-
| **`version_override`** | Set a specific version to display in the README.md
|
|
163
|
-
| **`version_prefix`** | Prefix the version with this value (if it isn't already prefixed)
|
|
164
|
-
| **`versioning_default_branch`** | If versioning is disabled show this branch instead
|
|
165
|
-
| **`title_prefix`** | Add a prefix to the README title
|
|
153
|
+
| **Input** | **Description** | **Default** | **Required** |
|
|
154
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----------------- | ------------ |
|
|
155
|
+
| **`action`** | The absolute or relative path to the `action.yml` file to read in from. | `action.yml` | **false** |
|
|
156
|
+
| **`readme`** | The absolute or relative path to the markdown output file that contains the formatting tokens within it. | `README.md` | **false** |
|
|
157
|
+
| **`owner`** | The GitHub Action repository owner. i.e: `bitflight-devops`|`your-gh-username` | | **false** |
|
|
158
|
+
| **`repo`** | The GitHub Action repository name. i.e: `github-action-readme-generator` | | **false** |
|
|
159
|
+
| **`save`** | Save the provided values in a `.ghadocs.json` file. This will update any existing `.ghadocs.json` file that is in place. | | **false** |
|
|
160
|
+
| **`pretty`** | Use `prettier` to pretty print the new README.md file | | **false** |
|
|
161
|
+
| **`versioning_enabled`** | Enable the update of the usage version to match the latest version in the `package.json` file | | **false** |
|
|
162
|
+
| **`version_override`** | Set a specific version to display in the README.md | | **false** |
|
|
163
|
+
| **`version_prefix`** | Prefix the version with this value (if it isn't already prefixed) | `v` | **false** |
|
|
164
|
+
| **`versioning_default_branch`** | If versioning is disabled show this branch instead | `main` | **false** |
|
|
165
|
+
| **`title_prefix`** | Add a prefix to the README title | `GitHub Action: ` | **false** |
|
|
166
166
|
|
|
167
167
|
<!-- end inputs -->
|
|
168
168
|
<!-- start outputs -->
|
|
169
169
|
<!-- end outputs -->
|
|
170
|
-
<!-- start [.github/
|
|
171
|
-
<!-- end [.github/
|
|
170
|
+
<!-- start [.github/ghadocs/examples/] -->
|
|
171
|
+
<!-- end [.github/ghadocs/examples/] -->
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "github-action-readme-generator",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.4",
|
|
4
4
|
"description": "This is a CLI tool and GitHub Action that reads in the details from a \nGitHub Action's `action.yml` file and updates the `README.md` file\nwith the `name`, `description`, `usage`, `inputs`, `outputs`, and\nexamples of the action.\nConfiguration can be provided via a `.ghadocs.json` file stored in the\nroot directory of the Action's repository, via the command line when\nusing the cli, or via the `with:` section of this Action.\n\n\nThis tool uses markdown comments as delimiting tokens within the `README.md`\nfile to determine where to place the generated content.\n\n[`README.example.md`](README.example.md) example with all fields filled in, and no other free-form content.",
|
|
5
5
|
"main": "dist/index.cjs",
|
|
6
6
|
"types": "dist/index.d.ts",
|