search

visual-space / visual-editor

Rich text editor for Flutter based on Delta format (Quill fork)
MIT License
280 stars 44 forks source link

Sys - GitHub Actions Continuous Integration #227

Open nelsonic opened 1 year ago

nelsonic commented 1 year ago

Hi @adrian-moisa, 👋 Stoked you've made this fork and are focussing on Docs & Demos. 😍

We're keen to use your editor for an [Open Source] project. 📱 However ... At present the repo doesn't appear to have any automated testing: https://github.com/visual-space/visual-editor/actions image

Would you accept a PR adding GitHub Actions Continuous Integration to the repo so that tests run automatically for each commit/PR? It will give people considering using your package more assurance that everything is working as expected. ✅ Thanks. 👌

adrian-moisa commented 1 year ago

Hi @nelsonic! Sure thing, I'd be happy to receive such a commit. Now the thing is that we don't have yet any significant progress made on the testing side. However this is about to change in about 2 months. We've worked very hard on our internal codebase for the startup. Now we are getting close to go live and we want to start moving focus to testing. If you are interested to join the testing effort I'd be happy to coordinate with you. Otherwise you'll have to be patient for Oct. We are neck deep in some last mile work. Afterwards we will switch focus to the editor. There are many known bugs left to polish. And then more new features.

nelsonic commented 12 months ago

@LuchoTurtle when you have a moment, please help setup CI for this project similar to how we have it in our Dart/Flutter projects. Then we can add a couple of tests for the functionality we want to use. 🙏

LuchoTurtle commented 12 months ago

I can surely get a basic integration PR going. Would something like https://github.com/dwyl/flutter-navigation-menu-demo/blob/main/.github/workflows/ci.yml suffice?

I wonder @adrian-moisa , do you guys use Codecov for code coverage reporting?

adrian-moisa commented 12 months ago

I think it looks good enough for a start. Now the thing is that on the testing side there's not much done. As I explained eralier, it's planned ahead. I also have to setup a pub dev release.

@LuchoTurtle I'm available on discord for a quick meeting to plan ahead. This is the link. You can find me under the name SpaceInstructor. I can also answer other VE questions.

Edit: In case you need an overview of the editor architecture. Would be nice to update that document as well with the changes for the GH actions.

LuchoTurtle commented 12 months ago

Thanks for the quick reply @adrian-moisa 😊

I've created a small PR #223 that will add some very basic tests. It assumes y'all use Codecov (which is free and quite easy to set up) for code coverage monitoring.

I've also joined your Discord server. As I delve into visual-editor's codebase and questions arise, I'll post my questions there :)

Thank you very much!

adrian-moisa commented 12 months ago

Btw, I did not get to update the readme. We are using 160 chars limit. It was a decission implemented recently out of frustration with how the autofromater works in many edge cases. It's a new direction, did not update the whole code base yet. So there's time to turn around in case of major pushback. I will investigate if there's a way to override Android Studio limit on a per project basis.