Redocly / Redocly/redocly-cli

Files section in redocly.yaml file is ignored and when executing a 'push' command all files from the folder are being pushed

Open
#1,689 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

c1 p2 Type: Bug
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

Describe the bug

When attempting to push an API to the Redocly API Registry using CI/CD, all files in the folder are being pushed instead of files selected in redocly.yaml

To Reproduce
Steps to reproduce the behavior:

  1. Create an API Registry using CI/CD.
  2. Create a folder with yaml file, index.html file and other files.
apis:
  testclipush@v1:
    root: test.yaml

files:
  - index.html
extends: 
  -  minimal
theme:
  openapi:
    htmlTemplate: ./index.html
    hideTryItPanel: false
    theme:
      colors:
        primary:
          main: '#0065FB'
  1. In files select to only upload index.html
  2. Execute push command
  3. Observe that all files from the folder will be pushed

Expected behavior

Only selected files should be pushed

Sample file:
333.zip

Front logo Front conversations

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the push command with the provided sample archive and redocly.yaml, focusing on the files entry and the folder contents. Trace how the CLI selects files for upload and verify that the completed behavior uploads only index.html rather than every file in the folder.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.