readmeio / rdme

ReadMe's official command-line interface (CLI) and GitHub Action 🌊

Home Page:https://docs.readme.com/main/docs/rdme

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Filename in quotes no longer working

dxin93 opened this issue · comments

commented

Hi,

Our team was using the rdme openapi tool to automatically sync our docs on pull requests. This broke for us recently because filenames in quotes are no longer supported.

Previously this worked:

        with:
          rdme: openapi "<file_name>" --key ${{ secrets.README_DEVELOPMENT_API_KEY }} --id ${{ secrets.README_DEV_ID }}

We fixed it on our side by removing the quotes but in the future please be more careful about making breaking changes, thanks!

Apologies for the issues @dxin93! We didn't actually make any breaking changes on this front so I'm not sure what caused this. Do you have the rdme versions where this was working and when it broke?

commented

No worries @kanadgupta. I believe we're using rdme:8.6.0. The last time we ran the automation successfully was Monday (March 27), and it failed today (March 30) but we didn't have any runs between that time.

Do you have any idea what version you were on previously? And can you send along the error message that you saw in the failure?

Per my testing, file names in quotes still appear to work in rdme@8.6.0:

CleanShot 2023-03-30 at 13 27 19@2x

Could you also provide the file name you're using?

commented

I'm not sure what the minor version was before, here's the last successful run before today:

image

And here's the failed run (without any changes on our side):
image

And here is our GitHub actions config:

  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: readmeio/rdme@v8
        with:
          rdme: openapi "docs/v202209/aurora_sync_api_spec_oas.yaml" --key ${{ secrets.README_DEVELOPMENT_API_KEY }} --id 630edd87a21082009ccbe08e

@dxin93 we confirmed the issue on our end, will post updates here as we have them. Apologies for the disruption and really appreciate you writing in about this!

commented

@kanadgupta Awesome, thanks for the quick response.

Hi @dxin93, a fix went out for this in 8.6.1 (including to the v8 tag). Thanks again for flagging this for us!

commented

Thanks @kanadgupta!