Princeton-LSI-ResearchComputing / tracebase

Mouse Metabolite Tracing Data Repository for the Rabinowitz Lab
MIT License
4 stars 1 forks source link

Superlinter black update #927

Closed lparsons closed 6 months ago

lparsons commented 6 months ago

Summary Change Description

Update SuperLinter to version 6. See list of significant changes here: https://github.com/super-linter/super-linter/blob/main/docs/upgrade-guide.md

In addition to changing the super-linter version, this required the following:

Affected Issues/Pull Requests

Review Notes

Checklist

This pull request will be merged once the following requirements are met. The author and/or reviewers should uncheck any unmet requirements:

hepcat72 commented 6 months ago

Ah, the guide linked in the description of the PR - that would be good to add to the yaml(s).

lparsons commented 6 months ago

Looks like the new black(/linters) made some healthy changes, but I'm curious about the process for the github yaml file updates. Did you make changes based on trial and error (and googling error messages) or did you follow some superlinter documentation? I see you added comments with links relating to some changes, so possibly a mix? If there were any other resources used, perhaps a comment at the top, documenting it would be useful. If not, then that's some insightful debugging.

I used the YAML provided in the README at https://github.com/super-linter/super-linter as a guide for most of the changes. Then got an error from the CHECKOV linter warning me about the top-level permissions for GitHub actions, so I added that.

Ah, the guide linked in the description of the PR - that would be good to add to the yaml(s).

We can, though it only seems relevant during the transition period to me. I didn't actually read or use that, tbh, just pointing others to it in case they found it useful.

lparsons commented 6 months ago

@fkang-pu and @jcmatese No need for a "review" of this PR, but wanted to make sure you were both aware before we merge this. It updates super-linter and some of the linter versions in the dev/requirements.txt to newer versions to match. Just in case you need / want to update anything in your own dev environments. Give a thumbs up here and we'll merge.

lparsons commented 6 months ago

@fkang-pu just pinging you to make sure you've seen this before we merge it. Can you thumb up or approve the PR to confirm? If you need more time, just let us know.