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

Registry wiki: document linters used in expected styleguides. #1038

Closed
timburks opened this issue Feb 22, 2023 · 3 comments
Closed

Registry wiki: document linters used in expected styleguides. #1038

timburks opened this issue Feb 22, 2023 · 3 comments
Assignees

Comments

@timburks
Copy link
Contributor

registry compute conformance requires local installation of any linters used in the style guide. We should document that for our commonly-used linters.

@timburks timburks moved this to Todo in Apigee API Registry Apr 5, 2023
@timburks timburks moved this from Todo to Concerning in Apigee API Registry Apr 5, 2023
@timburks timburks moved this from Concerning to Todo in Apigee API Registry Apr 5, 2023
@theganyo theganyo self-assigned this Apr 27, 2023
@theganyo theganyo moved this from Pressing to In Progress in Apigee API Registry Apr 27, 2023
@theganyo
Copy link
Member

I added a note on installation at the top of this page: https://github.com/apigee/registry/wiki/registry-compute. Is this sufficient?

Related: I noticed that two commands claim "soon to be deprecated" in this doc...

registry compute lint
Soon to be deprecated, please check compute conformance command.
Compute lint results for API specs

registry compute lintstats
Soon to be deprecated, please check compute score command.
Compute summaries of linter runs

However, these have not been deprecated and searching in our issues, I found there is a question of whether they even should be: #1121. We should decide to deprecate or not... as is, this will cause confusion.

@timburks
Copy link
Contributor Author

timburks commented May 2, 2023

I don't think these should be deprecated, at least not compute lint... the reason being that the styleguide infrastructure is powerful-but-complicated and I think it's useful to have a direct way to run linters to verify that the linter setup is correct.

@theganyo
Copy link
Member

theganyo commented May 2, 2023

Ok, thanks. I'm closing this as completed.

@theganyo theganyo closed this as completed May 2, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in Apigee API Registry May 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants