Add github actions - Githubissues

uab-cgds-worthey / cgds_repo_template

Template repo for CGDS repos. Visit the webpage below for usage instructions.

http://dev.cgds.uab.edu/computational/template_repo/

Other

2 stars 0 forks source link

Add github actions #2

Open ManavalanG opened 1 year ago

ManavalanG commented 1 year ago

[ ] Python linting - Lint configs added so far; see #4 for gh actions
[x] Mardkown linting - Lint configs added so far.
[x] Shell linting? - #11
[ ] R linting? - #12

What else?

ManavalanG commented 1 year ago

After discussion with Brandon, we decided this needs to be included. Badges showing pass/fail status will need to be included in readme.

ManavalanG commented 1 year ago

For Python linting, I am going with pylint based on the team's discussions in the past as well as its current use in rosalution. Note that we had a lot of discussions in the past to come up that's currently used in rosalution.

Where should the config file .pylintrc live? Based on the tool guidance, it will be stored at the project dir.

ManavalanG commented 1 year ago

Markdown linting. Using the config file used in MOO. Where to store? As per the linter doc, it will be stored at project dir.

ManavalanG commented 1 year ago

Putting a pause on pylint github actions atm. Will need to resume before this repo goes into production.

Questions when this is resumed:

is requirements.txt necessary?
What if we use conda env? What if there are multiple conda envs?
What would be a good "generic" environment that should go into template repo? Is this even possible?

See this for reference: https://github.com/uab-cgds-worthey/rosalution/blob/main/.github/workflows/python.yml

ManavalanG commented 1 year ago

Python linting is dealt in #14.