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

ci: adds lint check and fixes bad links and yaml formatting #3689

Merged
merged 4 commits into from
Jan 14, 2024

Conversation

codefromthecrypt
Copy link
Member

@codefromthecrypt codefromthecrypt commented Jan 14, 2024

This adds new scripts configure_lint and lint which work like our other build-bin scripts. These lint the workflow yaml and our markdown links.

I also removed the separate step for javadoc checking as it is easy to do that in the release test target, as well uses less resources vs doing it twice.

See openzipkin/zipkin-gcp#212 for the first impl of this. I will propagate the same style elsewhere after.

@codefromthecrypt
Copy link
Member Author

besides normal motivation, one is to make sure things pass before adding new links for #3649

Adrian Cole added 2 commits January 14, 2024 10:20
We should quote any example links and only add links for things that are
always up, or will be up due following instructions.

For example, we should add exceptions for localhost services that run in
result of test commands for zipkin or the UI.

See openzipkin/zipkin-gcp#212 for the first impl
of this.

Signed-off-by: Adrian Cole <[email protected]>
Adrian Cole added 2 commits January 14, 2024 12:30
Signed-off-by: Adrian Cole <[email protected]>
try
Signed-off-by: Adrian Cole <[email protected]>
@codefromthecrypt codefromthecrypt changed the title ci: adds lint check and fixed bad links ci: adds lint check and fixes bad links and yaml formatting Jan 14, 2024
@codefromthecrypt
Copy link
Member Author

I refactored this to be coherent with the other steps we do like test and deploy. This makes it easy to verify on your laptop the same as CI would do.

@codefromthecrypt codefromthecrypt merged commit a882a22 into master Jan 14, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants