search

thoriqadillah / moodle-qtype_essaysimilarity

Is a moodle question type plugin that compares the similarity between student's answer and teacher's answer key using machine learning (natural language processing), and uses the similarity to auto grade the answer. The automatic grade can be manually overridden by the teacher
https://thoriqadillah.github.io/cat-n-code/projects/essay-similarity/#demo
GNU General Public License v3.0
2 stars 3 forks source link

consider adding github actions support, it's free and very easy. #6

Closed danmarsden closed 1 year ago

danmarsden commented 1 year ago

Some of the tests run by the Moodle.org plugins db can be run via github actions on each commit in your github repo. Enabling this helps you to make sure future changes to your plugin will continue to follow the guidelines.

the short version - grab this file: https://github.com/moodlehq/moodle-plugin-ci/blob/master/gha.dist.yml rename it as ci.yml and put into the directory .github/workflows within tyour project eg: https://github.com/danmarsden/moodle-mod_attendance/blob/MOODLE_311_STABLE/.github/workflows/ci.yml

then on every commit you make to github it will fire off a request to run the tests and will give you traffic lights beside each commit and generate a report.

thoriqadillah commented 1 year ago

I'm sorry, I was unfamiliar with github action (I still am). Question: is the script is general purpose and just plug and play or should I modify something to work to this repo? Thank you in advance

danmarsden commented 1 year ago

The script is quite general purpose. It just needs to be copied into the right place in github. Just give it a go, you will probably find it makes sense once you play with it a bit.

thoriqadillah commented 1 year ago

Done

thoriqadillah commented 1 year ago

Hi, i am opening this issue again to ask some question I already create the github action script in the repo. And the result is failed everytime, and it looks mostly because indentation on my code style. Is it a blocker for plugin approval too?

danmarsden commented 1 year ago

no - most of the stuff that the codechecker reports as "error" are not blockers for approval - just room for improvement over time - in particular as the moodle.org plugins db reports on errors/warnings that appear in your code. If it starts reporting issues with 3rd party files you've embedded in the plugin, make sure the path to the external library is correct in your thirdpartylibs.xml file as those files are excluded from the moodle coding guideline tests.

thoriqadillah commented 1 year ago

Alright. All issue of the approval block has been resolved then