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

[TS-434] codacy-analysis-cli validate-configuration does not inform about file not starting with --- #482

Open
AlexBaranowski opened this issue Jun 21, 2023 · 1 comment
Labels
jira-issue Issue tracked on JIRA

Comments

@AlexBaranowski
Copy link
Contributor

Hi!

First of all, I'm thankful for Your product. Great job!

Yesterday I was playing with the Codacy config file. In documentation, there is the section with important paragraph https://docs.codacy.com/repositories-configure/codacy-configuration-file/#codacy-configuration-file saying that file must start with the ---.

OFC during writing my own .codacy.yml I somehow missed it. I validated the file with the:

codacy-analysis-cli validate-configuration --directory $(pwd)

And it **did not ** inform me about this mistake.

To sum it up:

File

---
exclude_paths:
  - "**/testsuite/**"

output

Successfully loaded the Codacy configuration file in /home/Alex/tmp/XXX/.codacy.yaml
CodacyConfigurationFile(None, Some(Set(Glob("**/testsuite/**"))), None)

File without ---

exclude_paths:
  - "**/testsuite/**"

output

Successfully loaded the Codacy configuration file in /home/Alex/tmp/XXX/.codacy.yaml
CodacyConfigurationFile(None, Some(Set(Glob("**/testsuite/**"))), None)

I'm believing that for a file that does not begin with --- it should print an error.

Best,
Alex

@github-actions github-actions bot added the jira-issue Issue tracked on JIRA label Jun 21, 2023
@github-actions github-actions bot changed the title codacy-analysis-cli validate-configuration does not inform about file not starting with --- [TS-434] codacy-analysis-cli validate-configuration does not inform about file not starting with --- Jun 21, 2023
@github-actions
Copy link

Internal ticket created : TS-434

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira-issue Issue tracked on JIRA
Projects
None yet
Development

No branches or pull requests

1 participant