Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Filename in quotes no longer working #787

Closed
dxin93 opened this issue Mar 30, 2023 · 9 comments · Fixed by #788
Closed

Filename in quotes no longer working #787

dxin93 opened this issue Mar 30, 2023 · 9 comments · Fixed by #788
Labels
bug Something isn't working GHA / CI Issues specific to GitHub Actions or other CI environments

Comments

@dxin93
Copy link

dxin93 commented Mar 30, 2023

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!

@kanadgupta
Copy link
Member

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?

@kanadgupta kanadgupta added the question Further information is requested label Mar 30, 2023
@dxin93
Copy link
Author

dxin93 commented Mar 30, 2023

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.

@kanadgupta
Copy link
Member

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?

@kanadgupta
Copy link
Member

Per my testing, file names in quotes still appear to work in [email protected]:

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

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

@dxin93
Copy link
Author

dxin93 commented Mar 30, 2023

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

@kanadgupta kanadgupta added bug Something isn't working GHA / CI Issues specific to GitHub Actions or other CI environments and removed question Further information is requested labels Mar 31, 2023
@kanadgupta
Copy link
Member

@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!

@dxin93
Copy link
Author

dxin93 commented Mar 31, 2023

@kanadgupta Awesome, thanks for the quick response.

@kanadgupta
Copy link
Member

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

@dxin93
Copy link
Author

dxin93 commented Apr 5, 2023

Thanks @kanadgupta!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working GHA / CI Issues specific to GitHub Actions or other CI environments
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants