Skip to content

GHA Onboarding Prompt breaks CI in Jenkins/CloudBees #664

@lanz

Description

@lanz

We use rdme to sync our API specs with ReadMe. We have a build job set to run in Jenkins/CloudBees that runs the following command for several specs when content is merged in our repo:

rdme openapi "output/swagger/spec.json" --key="<redacted>" --id="<redacted>"

This has worked flawlessly for the past ~2 years; however, after upgrading to the most recent version of the rdme package, we're now being prompted if we would like to add a GitHub action after running the command. This breaks our automated scripts that we use for continuous integration via Jenkins/CloudBees because there is no user to input a response in a continuous integration environment.

I realize that the question is only asked once, and once a user responds with "no" then the question is never asked again. However, as I mentioned, there's no user in a continuous integration environment to input a response at the prompt.

Note that the above command is the recommended approach for continuous integration according to the documentation for the rdme package in npm.

The rdme tool should be changed to not require user input when updating specs using the above command since it breaks automated scripts. At the very least a flag should be added that suppresses user input prompts.

Note that we can't use GitHub Actions for several reasons. Unless the above is fixed we'll be unable to continue updating our specs in ReadMe automatically.

API

Metadata

Metadata

Assignees

No one assigned

    Labels

    GHA / CIIssues specific to GitHub Actions or other CI environmentsquestionFurther information is requested

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions