feat: ✨ Codefair v2 #61

slugb0t · 2024-08-28T21:27:58Z

New additions to Codefair have been added:

Full CWL Validation to entire repositories and an updated UI to see the reports. A newer validation tool has been updated to provide user friendly reports. The older version was a typescript validator from the CWL team while the new one is the CWL team's python validator.
UI Dashboard has been added for beta testing. The dashboard will provide a central location of the repositories being managed by Codefair and allow users to update their FAIR Compliance items along with rerunning CWL validations and/or entire FAIR compliance check.
Mention of the FAIR-BioRS Guidelines have been removed to prevent users from thinking Codefair is solely for biomedical research software.
Workflow on the bot has been optimized to allow potential contributors to quickly and better understand the codebase.
File restructuring was done on the bot side to follow standards
Single instance db was created for the bot to prevent the db being need to be passed as a parameter through most of the bot functions.
An action queue was created for users who install Codefair to a large number of repositories in one installation. This will prevent an organization/user account from being spammed with alerts on issues being opened for each repository. The action queue will be require 5 actions on said repository (pushing to main or pull request opened). Thereafter Codefair will begin it's workflow and create a FAIR Compliance Dashboard Issue
Logging has been updated on the bot side to use Consola for better tracking of bot errors and runtime details

* ✨ feat: add support for cwl validation * 🚧 wip: rework ui for validation_message * ✨ feat: add support for rerunning validations * 🐛 fix: update server error mesage key * 🐛 fix: sanity check for dashboard issue * 🐛 fix: update description text

…ering, updated CWL github issue template (#42) * feat: ✨ support for .cwl file checks (#39) * refactor: ♻️ update on ui and issue dashboard text (#40) * feat: ✨ support for .cwl file checks * refactor: update ui text and dashboard message * feat: ✨ recursive search for all cwl files in repo * wip: 🚧 handle multiple cwl validations * feat: ✨ validate multiple cwl files across repo * feat: ✨ validate cwl files with deployed server * refactor: ♻️ apply collapsible table for cwl validation report * feat: ✨ db singleton + issue number added to installation table * chore: 🔨 code cleanup * feat: ✨ remove db as parameters throughout codefair bot * fix: 🐛 patch verify repo name function * docs: 📝 add JSDoc comments on new functions * refactor: ♻️ key value for issue number change * feat: ✨ rerun cwl validations from frontend, on uninstall delete repo from all collections * feat: ✨ handles for when issue is closed and reopened

…collection

* wip: optmizing bot code * feat: ✨ combined event listeners for bot + cwl template on no cwl files

* 🚧 wip: update dashboard ui * 🚧 wip: update dashboard ui * 💄 style: add breadcrumbs to pages * 🐛 fix: rework license ui on dashboard * ✏️ fix: update license body text * 🐛 fix: vhange view to edit on dashboard buttons

* wip: 🚧 create queue for large org installs * fix: 🐛 cwl private repo template only if cwls exist * fix: 🐛 gather proper file metadata and iterate through payload for push event * fix: 🐛 correct valid/total count in cwl template * bug: :fix: action count increase only if less than 4

…s on issue dashboard

…shboard

* 🚧 wip: add support for mongodb migrations * 🐛 fix: add support for github org membership verification * 💄 style: update alert ui * 🔊 chore: add console logs for migration steps * ⏪ revert: only run one update for the migration

* feat: ✨ remove deleted cwl files from db * dev: 📝 better comments * fix: 🐛 add await to db search, set to false if gatherd cwl is undefind * refactor: ♻️ convert getcwlFiles fn to a promise * refactor: ♻️ remove token from url string in priv repos, update emojis on validation report * refator: ♻️ sourcery notes * refactor: ♻️ sourcery notes (push fn out function block

* 🐛 fix: check github org permissions * 🔒️ fix: remove public config variable * 🔇 chore: remove logs

* wip: 🚧 action queue handling * refactor: ♻️ remove close issue feat when app is uninstalled

…into staging

…rn of template

* fix: 🐛 metadata url update + collection call correct * fix: 🐛 typo fix and exit workflow on push event if installation does not exist * feat: ✨ add codemeta file * feat: ✨ add citation file * Create CHANGELOG.md * Update README.md * Update README.md --------- Co-authored-by: codefair-app[bot] <165336008+codefair-app[bot]@users.noreply.github.com> Co-authored-by: Bhavesh Patel <b.patel@berkeley.edu>

fairdataihub-bot · 2024-08-28T21:28:00Z

Thank you for submitting this pull request! We appreciate your contribution to the project. Before we can merge it, we need to review the changes you've made to ensure they align with our code standards and meet the requirements of the project. We'll get back to you as soon as we can with feedback. Thanks again!

sourcery-ai · 2024-08-28T21:28:06Z

🧙 Sourcery has finished reviewing your pull request!

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
Continue your discussion with Sourcery by replying directly to review comments.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

sourcery-ai

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

bot/db.js

bot/index.js

bot/cwl/index.js

ui/components/ProfileStatus.vue

fairdataihub-bot · 2024-08-29T22:04:41Z

Thanks for closing this pull request! If you have any further questions, please feel free to open a new issue. We are always happy to help!

slugb0t and others added 30 commits July 25, 2024 13:01

feat: ✨ improvement to bot workflow

e32e766

fix: 🐛 correct codemeta url

922dbff

fix: 🐛 correct collection call with correct name

4a53a59

style: 🎨 prettier refactor

cf0bfca

refactor: ♻️ update on call for installation and analytics collection

40b9fd3

refactor: ♻️ exit push event in the case of no entry in installation …

ed91ea5

…collection

feat: ✨ bot event listeners concised + extra cwl validation checks (#43)

098c94a

* wip: optmizing bot code * feat: ✨ combined event listeners for bot + cwl template on no cwl files

fix: 🐛 add await to db call

2f06a2a

fix: 🐛 overwriting previous cwl files in db patched

7293f75

feat: ✨ set action key to false upon reaching action count limit

631d34a

feat: ✨ full run through on action limit, display previous validation…

fa72532

…s on issue dashboard

dev: 📝 better comments

f9b3791

feat: ✨ better comments and always show total validations on issue da…

f4583bd

…shboard

✨ feat: add a simple faq for errors (#47)

8a59388

refactor: ♻️ const declaration on validateCWLFile function call

39d4f8b

feat: ✨ consola for logging (#49)

ea5f153

🐛 fix: check github org permissions (#50)

1794a53

* 🐛 fix: check github org permissions * 🔒️ fix: remove public config variable * 🔇 chore: remove logs

🧑‍💻 chore: remove old dashboard

3e61a06

refactors: ♻️ action limit update (#51)

7f2b6c2

* wip: 🚧 action queue handling * refactor: ♻️ remove close issue feat when app is uninstalled

Merge branch 'staging' of https://github.com/fairdataihub/codefair-app …

1225839

…into staging

📈 feat: add metrics for ui side (#52)

b2ec880

feat: ✨ analytics validatedFileCount (#53)

5b9807b

fix: 🐛 if file is deleted, check for overall status before final retu…

c577af6

…rn of template

chore: 🔨 todo removed

941bec8

slugb0t and others added 14 commits August 27, 2024 10:28

fix: 🐛 get default branch name for commit info

3aa0a06

fix: 🐛 patch iterating through existing cwl files for removal

e5b2424

refactor: ♻️ Prettier refactors

02b03ff

refactor: ♻️ display repos with no action limit in UI dashboard

9b2d9eb

refactor: 🏗️ update bot file structure (#59)

4d58422

refactor: 🎨 standardize spacing of content for dashboard cards

3ec85bd

refactor: ♻️ update on styling of repo cards

4a5bd2c

fix: 🐛 correct typo in README

bb92783

feat: 🔖 bump version number to v2.0.0

a33c789

feat: ✨ activate dashboard

a34ecd2

refactor: ♻️ remove mention of the fair-biors guidelines in bot

a9d3883

feat: ✨ if issue is reopened update the latest commits in db

97df0a9

feat: ✨ fetch commit details if bot yet has not done so

4fd4f61

sourcery-ai bot reviewed Aug 28, 2024

View reviewed changes

bot/db.js Outdated Show resolved Hide resolved

bot/db.js Outdated Show resolved Hide resolved

bot/index.js Outdated Show resolved Hide resolved

slugb0t requested a review from megasanjay August 28, 2024 21:28

revert: ⏪ remove fetching commits from UI

738c098

megasanjay reviewed Aug 29, 2024

View reviewed changes

bot/cwl/index.js Show resolved Hide resolved

ui/components/ProfileStatus.vue Outdated Show resolved Hide resolved

Bhavesh Patel and others added 8 commits August 29, 2024 14:31

Update CITATION.cff

0a9a7ad

Update codemeta.json

b5a2567

Update README.md

d957734

Update CHANGELOG.md

a8027b9

update: 📝 update CHANGELOG for v2

4ce4e8b

Merge branch 'main' into staging

4b6c306

refactor: ♻️ PR feedback resolved

4161959

refactor: ♻️ update validator endpoint

099bf89

slugb0t merged commit 3ac9ee4 into main Aug 29, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ✨ Codefair v2 #61

feat: ✨ Codefair v2 #61

slugb0t commented Aug 28, 2024

fairdataihub-bot bot commented Aug 28, 2024

sourcery-ai bot commented Aug 28, 2024 •

edited

Loading

sourcery-ai bot left a comment

fairdataihub-bot bot commented Aug 29, 2024

feat: ✨ Codefair v2 #61

feat: ✨ Codefair v2 #61

Conversation

slugb0t commented Aug 28, 2024

fairdataihub-bot bot commented Aug 28, 2024

sourcery-ai bot commented Aug 28, 2024 • edited Loading

sourcery-ai bot left a comment

Choose a reason for hiding this comment

fairdataihub-bot bot commented Aug 29, 2024

sourcery-ai bot commented Aug 28, 2024 •

edited

Loading