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

Stop creating linter report files in CI #6560

Merged
merged 1 commit into from
Jul 27, 2023

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Jul 25, 2023

Motivation and context

Currently, when one of the linters reports a problem, if you want to see what that problem is, you have to do the following:

  1. Click on the "Details" link in the PR.
  2. Click "Summary".
  3. Click the artifact (also, depending on the browser, choose where to save it).
  4. Open the downloaded file (which is an archive).
  5. Open the report file from the archive.
  6. Delete the archive after you're done.

That is far too much hassle, and all it gives you is a slightly fancier- looking report (and sometimes not even that, like in the case of black).

So just remove all the report building and uploading. Now the above procedure is reduced to:

  1. Click "Details".
  2. Expand the appropriate build step.

How has this been tested?

I deliberately introduced errors specific to each linter and used act to make sure the workflows run as expected.

Checklist

  • I submit my changes into the develop branch
  • [ ] I have added a description of my changes into the CHANGELOG file
  • [ ] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • [ ] I have linked related issues (see GitHub docs)
  • [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Currently, when one of the linters reports a problem, if you want to see
what that problem is, you have to do the following:

1. Click on the "Details" link in the PR.
2. Click "Summary".
3. Click the artifact (also, depending on the browser, choose where to save it).
4. Open the downloaded file (which is an archive).
5. Open the report file from the archive.
6. Delete the archive after you're done.

That is far too much hassle, and all it gives you is a slightly fancier-
looking report (and sometimes not even that, like in the case of black).

So just remove all the report building and uploading. Now the above
procedure is reduced to:

1. Click "Details".
2. Expand the appropriate build step.
Copy link
Contributor

@sizov-kirill sizov-kirill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, I'm tired of downloading this linter's artifacts too

@SpecLad SpecLad merged commit 3e84570 into cvat-ai:develop Jul 27, 2023
@SpecLad SpecLad deleted the remove-lint-reports branch July 27, 2023 10:13
mikhail-treskin pushed a commit to retailnext/cvat that referenced this pull request Oct 25, 2023
Currently, when one of the linters reports a problem, if you want to see
what that problem is, you have to do the following:

1. Click on the "Details" link in the PR.
2. Click "Summary".
3. Click the artifact (also, depending on the browser, choose where to
save it).
4. Open the downloaded file (which is an archive).
5. Open the report file from the archive.
6. Delete the archive after you're done.

That is far too much hassle, and all it gives you is a slightly fancier-
looking report (and sometimes not even that, like in the case of black).

So just remove all the report building and uploading. Now the above
procedure is reduced to:

1. Click "Details".
2. Expand the appropriate build step.
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