Arduino Working Group

[scriptkkiddie]

WORKING GROUP NAME: [ Arduino ]

WORKING GROUP PURPOSE: [ Working Group for Arduino with Ansible integration ]

AT LEAST TWO INITIAL WORKING GROUP MEMBERS: [ GitHub: @ScriptKKiddie ] [ GitHub: @webdevprashant ] [ GitHub: @Sachin19191 ]

[gundalow]

Hi, Apologies I seemed to have missed this request.

I think this could be really interesting, thank you. So I can setup the best thing for you. What do you picture this looking like?

1. documentation and examples of how to use Arduino?
2. Arduino collection containing new modules?
3. Arduino collection containing Roles & playbooks?
4. Something else?

[scriptkkiddie]

Hey @gundalow , Thanks for your reply. This time, option 1 is very fine according to the current use case and how I've done the integration of Arduino + Ansible together. In the future, after lots of research and practical implementation, I'll start working on modules as well.

For Demonstration, Please go through this video below https://www.youtube.com/watch?v=VK4iJoLrdM8

Thanks :)

[scriptkkiddie]

Hey, @gundalow Any update?

[gundalow]

@ScriptKKiddie Hi :) I'm wondering what we can do to best support this, though I don't know much about Arduino What modules do you have? Is it for building Arduino images locally, then pushing them to the Arduino board (if that's the right terminology) Is it for connecting to existing Arduino systems and changing configuration

Do you have any links to existing GitHub repos I could look at?

I'm wondering if we create a community.arduino collection for the modules & roles?

[scriptkkiddie]

Hi @gundalow Sir!

It is currently for connecting to Arduino Hardware Device/System and changing its configuration and uploading sketch (firmware)!

It sounds cool?

For Demonstration, Please go through this video below https://www.youtube.com/watch?v=VK4iJoLrdM8

[scriptkkiddie]

Hey @gundalow, Any Update?

[scriptkkiddie]

Any update @gundalow ?

[Andersson007]

Hello @ScriptKKiddie I'm trying to figure out what would be the best way to proceed.

If you have a bunch of roles / plugins to automate Arduino related tasks, we could create a repository called, say, community.arduino containing a collection skeleton for you under the ansible-collections organization. Then we'll grant the maintainer permissions to you / your team and you could fill it up with the stuff you created. It can be your WG there, i.e. a group of contributors and maintainers working together on developing that stuff. What do you think?

If you need anything different (e.g. create a dedicated Matrix channel or anything else we can do), please let us know

Thanks for your interest

[scriptkkiddie]

Hi @Andersson007

Yes, Exactly the same I wanted

I've been working on Arduino and Ansible integration and successfully done it. Let's begin the whole process of creating collection or working group.

Looking forward to it!

[Andersson007]

@ScriptKKiddie the https://github.com/ansible-collections/community.arduino has been created and I've added it to Zuul release publishing.

Please read carefully and save the following somewhere (some of the statements are applicable only to modules and plugins but not for roles).

Important information for maintainers:

• Subscribe to the news-for-maintainers repo and track announcements there. The ansible-core developers publish there changes related to CI (and not only). So if you later set up testing, you'll be informed in advance about the changes. Otherwise, your CI will get red one day in PRs for unclear reasons.
• It's also highly recommended to subscribe to Bullhorn, our weekly contributor newsletter.
• Make your collection satisfies the Collection requirements. You can also use the Collection checklist as the requirements' short version to mark items as complete.
• Make sure your collection content follows the Ansible development convensions.
• Make sure your collection documentation follows the Ansible documentation standards and the Style guide
• Set up testing:
  • If your collection repo was created using collection_template, it already contains basic GitHub Actions workflows for sanity, unit and integration tests in the .github/workflows directory. Otherwise, copy the workflows to your repo. Then enable the workflows on the Actions tab of your repo.
  • Testing collections using GitHub actions is convenient when you don't need to test against many OS distributions, otherwise you can use Azure Pipelines TBD.
  • If you're unfamiliar with testing in Ansible:
  • read the Testing guidelines
  • read the Integration testing quick-start quide and Unit testing quick-start guide
  • try out testing-related Instruqt interactive courses
  • you can find examples of unit and integration tests in collection repositories under the ansible-collections organization, for example, in community.general, community.docker or community.crypto
• Read the Collection maintainer guidelines and follow their recommendations.
• Release the collection using Git tags and following Semantic Versioning. Read the Releasing guidelines to learn details. In most cases when releasing, we follow the releasing-without-branches guide.
• If a community engineer added your collection to Zuul release autopublishing, new versions of your collection will appear on Ansible Galaxy automatically: Zuul will publish it when it sees a new Git tag in the collection repo.
• Be engaged in communication. Read the Communication guidelines to learn possible ways.
• When the collection sanisfies the Collection requirements, you can submit it for inclusion in the Ansible package.
• Share the above with other (and forther) maintainers.

I'll close the issue. If you have any questions, we're already in touch via email, feel free to ask there. Thank you!

[Andersson007]

Dear WG leaders, please consider requesting a forum group and use it instead of wiki pages (if you didn't do it yet). after that:

• consider replacing the wiki page's content with a link to forum
• raise a PR against the Communication guide to change a corresponding reference
• announce and invite people to join your new shiny forum group on Matrix and via Bullhorn

Closing the issue:) Thanks