You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: __tests__/commands/docs/__snapshots__/upload.test.ts.snap
+78-26Lines changed: 78 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,9 @@
3
3
exports[`rdme docs upload > given that ReadMe project has bidirection sync set up > should error if validation is not skipped 1`] =`
4
4
{
5
5
"error": [Error: Bi-directionalsyncingisenabledforthisproject. Uploadingthesedocswilloverwritewhat's currently synced from Git. To proceed with the upload, re-run this command with the \`--skip-validation\` flag.],
6
-
"stderr": "",
6
+
"stderr": " › Warning: This command is in an experimental alpha and is likely to change.
7
+
› Useatyourownrisk!
8
+
",
7
9
"stdout": "",
8
10
}
9
11
`;
@@ -13,7 +15,9 @@ exports[`rdme docs upload > given that ReadMe project has bidirection sync set u
13
15
"error": [APIv2Error: ReadMeAPIerror: TheAPIkeycouldn't be located.
14
16
15
17
TheAPIkeyyoupassedin (bad-api-key) doesn't match any keys we have in our system. API keys must be passed in via Bearer token. You can get your API key in Configuration > API Key, or in the docs.],
16
-
"stderr": "",
18
+
"stderr": " › Warning: This command is in an experimental alpha and is likely to change.
19
+
› Useatyourownrisk!
20
+
",
17
21
"stdout": "",
18
22
}
19
23
`;
@@ -33,7 +37,9 @@ exports[`rdme docs upload > given that ReadMe project has bidirection sync set u
33
37
"skipped": [],
34
38
"updated": [],
35
39
},
36
-
"stderr": " › Warning: Bi-directional syncing is enabled for this project. Uploading
40
+
"stderr": " › Warning: This command is in an experimental alpha and is likely to change.
"error": [Error: Thedirectoryyouprovided (__tests__/__fixtures__/ref-oas) doesn't contain any of the following file extensions: .markdown, .md, .mdx.],
134
-
"stderr": "- 🔍 Looking for Markdown files in __tests__/__fixtures__/ref-oas...
144
+
"stderr": " › Warning: This command is in an experimental alpha and is likely to change.
"error": [AggregateError: Multipledryrunsfailed. Toseemoredetailederrorsforapage, run \`rdme docs upload <path-to-page.md>\` --dry-run.],
144
-
"stderr": "- 🔍 Looking for Markdown files in __tests__/__fixtures__/docs/mixed-docs...
156
+
"stderr": " › Warning: This command is in an experimental alpha and is likely to change.
157
+
› Use at your own risk!
158
+
- 🔍 Looking for Markdown files in __tests__/__fixtures__/docs/mixed-docs...
145
159
✔ 🔍 Looking for Markdown files in __tests__/__fixtures__/docs/mixed-docs... 5 file(s) found!
146
160
- 🔬 Validating frontmatter data...
147
161
⚠ 🔬 Validating frontmatter data... issues found in 2 file(s).
@@ -167,7 +181,9 @@ exports[`rdme docs upload > given that the file path is a directory > should han
167
181
exports[`rdme docs upload > given that the file path is a directory > should handle a mix of creates and updates and failures and skipped files 1`] = `
168
182
{
169
183
"error": [AggregateError: Multiplepageuploadsfailed. Toseemoredetailederrorsforapage, run \`rdme docs upload <path-to-page.md>\`.],
170
-
"stderr": "- 🔍 Looking for Markdown files in __tests__/__fixtures__/docs/mixed-docs...
184
+
"stderr": " › Warning: This command is in an experimental alpha and is likely to change.
185
+
› Use at your own risk!
186
+
- 🔍 Looking for Markdown files in __tests__/__fixtures__/docs/mixed-docs...
171
187
✔ 🔍 Looking for Markdown files in __tests__/__fixtures__/docs/mixed-docs... 5 file(s) found!
172
188
- 🔬 Validating frontmatter data...
173
189
⚠ 🔬 Validating frontmatter data... issues found in 2 file(s).
@@ -211,7 +227,9 @@ exports[`rdme docs upload > given that the file path is a directory > should upd
211
227
},
212
228
],
213
229
},
214
-
"stderr": "- 🔍 Looking for Markdown files in __tests__/__fixtures__/docs/existing-docs...
230
+
"stderr": " › Warning: This command is in an experimental alpha and is likely to change.
@@ -240,7 +258,9 @@ exports[`rdme docs upload > given that the file path is a single file > and the
240
258
"skipped": [],
241
259
"updated": [],
242
260
},
243
-
"stderr": "- 🔬 Validating frontmatter data...
261
+
"stderr": " › Warning: This command is in an experimental alpha and is likely to change.
262
+
› Useatyourownrisk!
263
+
- 🔬 Validatingfrontmatterdata...
244
264
✔ 🔬 Validatingfrontmatterdata...noissuesfound!
245
265
- 🚀 UploadingfilestoReadMe...
246
266
✔ 🚀 UploadingfilestoReadMe...done!
@@ -254,7 +274,9 @@ exports[`rdme docs upload > given that the file path is a single file > and the
254
274
exports[`rdme docs upload > given that the file path is a single file > and the command is being run in a CI environment > should error out if the file has validation errors 1`] = `
255
275
{
256
276
"error": [Error: 1file(s) haveissuesthatshouldbefixedbeforeuploadingtoReadMe. Pleaserun \`rdme docs upload __tests__/__fixtures__/docs/mixed-docs/legacy-category.md --dry-run\` in a non-CI environment to fix them.],
257
-
"stderr": "- 🔬 Validating frontmatter data...
277
+
"stderr": " › Warning: This command is in an experimental alpha and is likely to change.
278
+
› Use at your own risk!
279
+
- 🔬 Validating frontmatter data...
258
280
⚠ 🔬 Validating frontmatter data... issues found in 1 file(s).
259
281
",
260
282
"stdout": "",
@@ -264,7 +286,9 @@ exports[`rdme docs upload > given that the file path is a single file > and the
264
286
exports[`rdme docs upload > given that the file path is a single file > given that the --dry-run flag is passed > should error out if a non-404 error is returned from the HEAD request 1`] =`
staticsummary='Upload Markdown files to the Guides section of your ReadMe project.';
14
+
statichidden=true;
15
+
16
+
staticsummary=`Upload Markdown files to the Guides section of your ReadMe project.\n\nNOTE: ${alphaNotice}`;
13
17
14
18
staticdescription=
15
19
'The path can either be a directory or a single Markdown file. The Markdown files will require YAML frontmatter with certain ReadMe documentation attributes. Check out our docs for more info on setting up your frontmatter: https://docs.readme.com/main/docs/rdme#markdown-file-setup';
0 commit comments