apiops icon indicating copy to clipboard operation
apiops copied to clipboard

[BUG] syntax error in run-publisher-with-env.yaml (using forward slash instead of backslash and not using glob pattern)

Open martin2176 opened this issue 1 year ago • 1 comments

Release version

v6.0.1.3

Describe the bug

@fabienmazieres I found that using the run-publisher-with-env.yaml which is published on the github doesn't run the spectral lint correctly due to syntax error. This is what is in the yaml

Run Spectral - uses: actions/setup-node@v4 with: node-version: "20" - run: npm install -g @stoplight/spectral-cli - run: spectral lint "${{ GITHUB.WORKSPACE }}/${{ inputs.API_MANAGEMENT_SERVICE_OUTPUT_FOLDER_PATH }}\apis*.{json,yml,yaml}" --ruleset https://raw.githubusercontent.com/connectedcircuits/devops-api-linter/main/rules.yaml

  1. The job runs on ubuntu-latest. So the forward slash directory reference is wrong
  2. under the apis directory, each api have a subdirectory. So a glob pattern should be used to match subdirectories The correct syntax is given below.

Expected behavior

  • run: spectral lint "${{ GITHUB.WORKSPACE }}/${{ inputs.API_MANAGEMENT_SERVICE_OUTPUT_FOLDER_PATH }}/apis/**/*.{json,yml,yaml}" --ruleset https://raw.githubusercontent.com/connectedcircuits/devops-api-linter/main/rules.yaml

Actual behavior

spectral lint doesnt run as expected

Reproduction Steps

Run the GH Actions pipeline provided in the github

martin2176 avatar Nov 01 '24 11:11 martin2176

  Thank you for opening this issue! Please be patient while we will look into it and get back to you as this is an open source project. In the meantime make sure you take a look at the [closed issues](https://github.com/Azure/apiops/issues?q=is%3Aissue+is%3Aclosed) in case your question has already been answered. Don't forget to provide any additional information if needed (e.g. scrubbed logs, detailed feature requests,etc.).
  Whenever it's feasible, please don't hesitate to send a Pull Request (PR) our way. We'd greatly appreciate it, and we'll gladly assess and incorporate your changes.

github-actions[bot] avatar Nov 01 '24 11:11 github-actions[bot]