Merge branch 'next' into kanad-2025-09-17/more-URL-uploading-quirks

Author: kanadgupta

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [10.5.3-next.1](https://github.com/readmeio/rdme/compare/v10.5.2...v10.5.3-next.1) (2025-10-08)
+
+
+### Bug Fixes
+
+* **openapi/upload:** restore `--working-directory` ([#1369](https://github.com/readmeio/rdme/issues/1369)) ([f8cd895](https://github.com/readmeio/rdme/commit/f8cd895d527dec83044f45d5096cfacaadc7fb86))
+
 ## [10.5.2](https://github.com/readmeio/rdme/compare/v10.5.1...v10.5.2) (2025-09-24)
 
 

CONTRIBUTING.md

@@ -26,6 +26,10 @@ bin/run.js openapi validate __tests__/__fixtures__/ref-oas/petstore.json
 
 Your changes to the command code may make changes to [the command reference documents](./documentation/commands) — it is up to you whether you include those changes in your PR or if you let the release process take care of it. More information on that can be found in [`MAINTAINERS.md`](./MAINTAINERS.md).
 
+## ReadMe Development 🦉
+
+If you're a ReadMe team member that's testing `rdme` against a non-production ReadMe environment, you can either set the `RDME_LOCALHOST=true` environment variable (which points your CLI to the localhost version of ReadMe) or modify the URLs in `src/lib/config.ts` directly.
+
 ## Running GitHub Actions Locally 🐳
 
 To run GitHub Actions locally, we'll be using [`act`](https://github.com/nektos/act) (make sure to read their [prerequisites list](https://github.com/nektos/act#necessary-prerequisites-for-running-act) and have that ready to go before installing `act`)!

README.md

@@ -114,11 +114,11 @@ For local CLI usage with a single project, you can authenticate `rdme` to your R
 > [!WARNING]
 > For security reasons, we strongly recommend providing a project API key via the `--key` option in automations or CI environments (GitHub Actions, CircleCI, Travis CI, etc.). It's also recommended if you're working with multiple ReadMe projects to avoid accidentally overwriting existing data.
 
-You can also pass in your API key via environmental variable. Here is the order of precedence when passing your API key into `rdme`:
+You can also pass in your API key via environment variable. Here is the order of precedence when passing your API key into `rdme`:
 
 1. The `--key` option. If that isn't present, we look for...
-1. The `RDME_API_KEY` environmental variable. If that isn't present, we look for...
-1. The `README_API_KEY` environmental variable. If that isn't present, we look for...
+1. The `RDME_API_KEY` environment variable. If that isn't present, we look for...
+1. The `README_API_KEY` environment variable. If that isn't present, we look for...
 1. The API key value stored in your local configuration file (i.e., the one set via `rdme login`)
 
 `rdme whoami` is also available to you to determine who is logged in, and to what project. You can clear your stored credentials with `rdme logout`.
@@ -133,7 +133,7 @@ To set this up, check out [1Password's documentation on the ReadMe shell plugin]
 
 ## Proxy
 
-`rdme` makes API requests to the ReadMe API, which is located at [dash.readme.com](https://dash.readme.com). If you need to configure a proxy for these requests, you can do so by setting the `HTTPS_PROXY` environmental variable.
+`rdme` makes API requests to the ReadMe API, which is located at [dash.readme.com](https://dash.readme.com). If you need to configure a proxy for these requests, you can do so by setting the `HTTPS_PROXY` environment variable.
 
 ```sh
 export HTTPS_PROXY=https://proxy.example.com:5678

__tests__/commands/openapi/__snapshots__/validate.test.ts.snap

@@ -65,7 +65,7 @@ jobs:
 "
 `;
 
-exports[`rdme openapi validate > GHA onboarding E2E tests > should create GHA workflow if user passes in spec via opt (including workingDirectory) 1`] = `
+exports[`rdme openapi validate > GHA onboarding E2E tests > should create GHA workflow if user passes in spec via opt (including working directory) 1`] = `
 {
   "result": "
 Your GitHub Actions workflow file has been created! ✨
@@ -88,7 +88,7 @@ Almost done! Push your newly created file (.github/workflows/validate-test-opt-s
 }
 `;
 
-exports[`rdme openapi validate > GHA onboarding E2E tests > should create GHA workflow if user passes in spec via opt (including workingDirectory) 2`] = `
+exports[`rdme openapi validate > GHA onboarding E2E tests > should create GHA workflow if user passes in spec via opt (including working directory) 2`] = `
 "# This GitHub Actions workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
 # You can view our full documentation here: https://docs.readme.com/docs/rdme
 name: ReadMe GitHub Action 🦉
@@ -111,7 +111,7 @@ jobs:
       - name: Run \`openapi validate\` command 🚀
         uses: readmeio/rdme@v7
         with:
-          rdme: openapi validate petstore.json --workingDirectory=./__tests__/__fixtures__/relative-ref-oas
+          rdme: openapi validate petstore.json --working-directory=./__tests__/__fixtures__/relative-ref-oas
 "
 `;
 
@@ -348,6 +348,17 @@ exports[`rdme openapi validate > should discover and upload an API definition if
 }
 `;
 
+exports[`rdme openapi validate > should use specified working directory (legacy flag) 1`] = `
+{
+  "result": "petstore.json is a valid OpenAPI API definition!",
+  "stderr": " ›   Warning: The "--workingDirectory" flag has been deprecated. Use 
+ ›   "--working-directory" instead.
+- Validating the API definition located at petstore.json...
+",
+  "stdout": "",
+}
+`;
+
 exports[`rdme openapi validate > should use specified working directory 1`] = `
 {
   "result": "petstore.json is a valid OpenAPI API definition!",

__tests__/commands/openapi/convert.test.ts

@@ -58,7 +58,7 @@ describe('rdme openapi convert', () => {
     await expect(
       run([
         spec,
-        '--workingDirectory',
+        '--working-directory',
         require.resolve(`@readme/oas-examples/2.0/json/${spec}`).replace(spec, ''),
         '--out',
         'output.json',
@@ -79,7 +79,7 @@ describe('rdme openapi convert', () => {
       await expect(
         run([
           spec,
-          '--workingDirectory',
+          '--working-directory',
           require.resolve(`@readme/oas-examples/3.0/${format}/${spec}`).replace(spec, ''),
         ]),
       ).resolves.toMatchSnapshot();

__tests__/commands/openapi/reduce.test.ts

@@ -62,7 +62,7 @@ describe('rdme openapi reduce', () => {
         prompts.inject(['tags', ['user'], 'output.json']);
 
         await expect(
-          run(['--workingDirectory', './__tests__/__fixtures__/relative-ref-oas']),
+          run(['--working-directory', './__tests__/__fixtures__/relative-ref-oas']),
         ).resolves.toMatchSnapshot();
 
         expect(Object.keys(reducedSpec.paths)).toStrictEqual(['/user']);
@@ -71,7 +71,7 @@ describe('rdme openapi reduce', () => {
       it('should reduce with no prompts via opts', async () => {
         await expect(
           run([
-            '--workingDirectory',
+            '--working-directory',
             './__tests__/__fixtures__/relative-ref-oas',
             '--tag',
             'user',
@@ -108,7 +108,7 @@ describe('rdme openapi reduce', () => {
       it('should reduce with no prompts via opts', async () => {
         await expect(
           run([
-            '--workingDirectory',
+            '--working-directory',
             './__tests__/__fixtures__/relative-ref-oas',
             '--path',
             '/pet',
@@ -134,7 +134,7 @@ describe('rdme openapi reduce', () => {
 
         await expect(
           run([
-            '--workingDirectory',
+            '--working-directory',
             './__tests__/__fixtures__/relative-ref-oas',
             '--path',
             '/pet',

__tests__/commands/openapi/validate.test.ts

@@ -40,11 +40,16 @@ describe('rdme openapi validate', () => {
   });
 
   it('should discover and upload an API definition if none is provided', async () => {
-    const result = await run(['--workingDirectory', './__tests__/__fixtures__/relative-ref-oas']);
+    const result = await run(['--working-directory', './__tests__/__fixtures__/relative-ref-oas']);
     expect(result).toMatchSnapshot();
   });
 
   it('should use specified working directory', async () => {
+    const result = await run(['petstore.json', '--working-directory', './__tests__/__fixtures__/relative-ref-oas']);
+    expect(result).toMatchSnapshot();
+  });
+
+  it('should use specified working directory (legacy flag)', async () => {
     const result = await run(['petstore.json', '--workingDirectory', './__tests__/__fixtures__/relative-ref-oas']);
     expect(result).toMatchSnapshot();
   });
@@ -55,7 +60,7 @@ describe('rdme openapi validate', () => {
       './__tests__/__fixtures__/nested-gitignored-oas/nest/petstore-ignored.json',
     );
 
-    const result = await run(['--workingDirectory', './__tests__/__fixtures__/nested-gitignored-oas']);
+    const result = await run(['--working-directory', './__tests__/__fixtures__/nested-gitignored-oas']);
     expect(result).toMatchSnapshot();
   });
 
@@ -138,13 +143,13 @@ describe('rdme openapi validate', () => {
       expect(fs.writeFileSync).toHaveBeenCalledWith(`.github/workflows/${fileName}.yml`, expect.any(String));
     });
 
-    it('should create GHA workflow if user passes in spec via opt (including workingDirectory)', async () => {
+    it('should create GHA workflow if user passes in spec via opt (including working directory)', async () => {
       const spec = 'petstore.json';
       const fileName = 'validate-test-opt-spec-workdir-file';
       prompts.inject([true, 'validate-test-opt-spec-github-branch', fileName]);
 
       await expect(
-        run([spec, '--workingDirectory', './__tests__/__fixtures__/relative-ref-oas']),
+        run([spec, '--working-directory', './__tests__/__fixtures__/relative-ref-oas']),
       ).resolves.toMatchSnapshot();
 
       expect(yamlOutput).toMatchSnapshot();