Forem: Alfonso Reyes

A GitHub action to trigger an alarm on your room 🚨

Alfonso Reyes — Fri, 11 Sep 2020 04:05:41 +0000

My journey on the actions hackathon

I'm submitting this post as part of my Actions Hackathon journey and also my participation.

Action in action:

Motivation

I always imagined open-source mantainers as heroes, since they spend lots of their free time just to share their knowledge with useful software and give back to the oss community, many times I've meet people who are passionate about OSS and for me they deserve the best.

So I'm making a simple action (my first one tho!) that is able to trigger an alarm on your room when someone opens up an Issue on your configured repositories, now you can feel like a hero when the city needs you! You may also remix this action to turn on a Batman signal on the ceiling of your room 🦸 🦇 (It's a great idea!)

I know is not pretty, but it serves it's purpose 👻

Submission Category:

Interesting IoT

Yaml File or Link to Code

on:
  issues:
    types: [opened]

jobs:
  do_iot_thing:
    runs-on: ubuntu-latest
    name: A job to turn on a light when someone opens an issue
    steps:
      - name: Send activation to ESP8266 device
        uses: 'mxarc/issuetron-3000@1.1'
        id: activation
        with:
          time: '15' # how much time we will keep our light on
          blink: true # enable blinking, otherwise just turn on the lamp
          io_user: '${{ secrets.IO_USER }}'
          io_key: '${{ secrets.IO_KEY }}'
          io_feed: 'issuetron'
          send_context: true
      # Use the output from the `hello` step
      - name: Check if we succeeded to turn on the light
        run: echo "The result of the action is ${{ steps.activation.outputs.success }}"

Link to the Action in marketplace:
https://github.com/marketplace/actions/issuetron-3000

Source code

ojoanalogo / issuetron-3000

🚨 Trigger a MQTT alert when someone opens an issue in one of your repositories

issuetron-3000 🚨

🚨 Turn on a light signal on the physical world when an issue is opened on one of your repos

This is my entry for the dev.to GitHub Actions hackathon

Index

issuetron-3000 🚨

About this

This is a really simple action intended to connect the real world with IoT devices connected to Adafruit IO Cloud.

It allows repo mantainers to keep alerted about new issues on their repos, made for the heros of the Open-Source 💙

🔧 I'm using Adafruit IO cloud for the ease of IoT development and device provisioning, since I know most people would like to configure a device the easy way and not have to go through complicated setups like AWS or Azure IoT.

The Action workflow is listening to an…

View on GitHub

How I'm making this

🔧 I'm using Adafruit IO cloud for the ease of IoT development and device provisioning, since I know most people would like to configure a device the easy way and not have to go through complicated setups like AWS or Azure IoT.

The Action workflow is listening to an "Issue" event and when it's triggered it gets the issue context (like username and issue title) and sends the content over MQTT protocol to an ESP8266 device which I had lying around, it turns on a red lamp which I got from a auto parts store. 🚨

Action is able to send context about the issue, being those details:

issue title
issue author
repo of origin

You can also disable the issue context if you want to save some bytes or you only want to trigger a custom action on your IoT device.

This action leverages repo secrets, since some variables like the device Key and ID are supposed to be secret, you can find more information on the README on how to setup your device.

Example of how to wire your IoT device

In the above image we have a red LED, but I suggest you use another source of light or maybe add a ring bell!

You can see the action in action here:
// Detect dark theme var iframe = document.getElementById('tweet-1295848520990302209-736'); if (document.body.className.includes('dark-theme')) { iframe.src = "https://platform.twitter.com/embed/Tweet.html?id=1295848520990302209&theme=dark" }

What I have learned creating this action

I was able to understand the basics of GitHub actions, the hackathon was the perfect motivation to begin learning more about this wonderful tool, I plan to make more IoT related projects in the future that use GitHub actions in one way or another.

The GitHub actions documentation it's the best place to start, don't be afraid to follow it, it covers everything from creating a starter project to deploying your first action.

My first time hosting a local Hacktoberfest meeting

Alfonso Reyes — Wed, 09 Oct 2019 22:12:42 +0000

My first time hosting a local Hacktoberfest meeting

Is that time of the year, where you can go outside and notice the smell of open source contributions, oh yes! the wonderful month of October.
The main purpose of this post (also my first post ever on the internet) is to share my thoughts, experiences, and mistakes I made that day, maybe you want to host a local hacktoberfest event in your city but don't know where to start? don't worry! I'll explain everything I did to make sure the meeting was possible.

Why I wanted to host a meeting of this kind.

Last year I participated in the Hacktoberfest event, and even though I felt like I didn't know too much about programming I wanted to contribute my grain of sand to the wonderful world of open source. When the semester of summer started I was expecting people to be wearing the hacktoberfest t-shirt in the school but to my surprise, most people never heard about it! I couldn't believe it, I wanted to change that and I proposed myself to do something the next year (and I did). Doing a meeting might be a small yet powerful action.

Who to invite? 🤔

Everyone, I mean everyone! graphic designers, writers, programmers, even lawyers; everyone can contribute to open source projects; you only need to find an adequate project for you, read the contribution guidelines and start contributing.

Before the event 📆

Before announcing your event to the public you need to do some arrangements, here's a list of steps we followed to be able to do this meeting:

Craft your event agenda and set a date you think works best for most of the people. Are you going to talk about open source and also give a workshop? be sure to assign enough time for each activity. Remember that workshops usually take more time because attendants might require some help from you.
Get confirmation from your workplace/school/local library. this is one of the most important things to do before announcing your event. Try to write a formal document explaining what you will be needing for the event and what day will it be held.
Work on social media promotion, try to reach as many people possible; we made an invitation to every local university/college with STEM careers and local groups in Facebook, word of mouth publicity also works very well. A Facebook event works well, or a Meetup
Invite some people to talk at your event, someone that you believe can leave an impact on the people, for example, people who have worked in open source projects or are involved in communities around open source.
Make some Powerpoint/images for your presentation, there are some assets in the Hacktoberfest website you might want to use; remember to not use too much text and be as much visual you can.
Keep advertising your event, be kind and friendly when inviting people 😁.

My instructions are a fork of the Step by step guide in the official Hacktoberfest website
Hacktoberfest Event kit take a look if you want to get more information.

During the meeting

We started welcoming people at 3:00 PM, by that hour we were almost ready to start

We began talking about Open Source, Hacktoberfest, Why it's important to contribute to this type of project and the experience you acquire by doing so.
It's very important to talk about it, after all the main focus it's Open Source, isn't it?

I invited a friend of mine to talk about her experience with open source projects in Mexico and people she knew were involved, she gave a great talk to all of the attendants and gave tips on how to start the journey. A lot of valuable knowledge from one of the best persons I've ever met 😀 I can't be thankful enough with her.

Following the agenda we began with a workshop (given by my friend Carlos Contreras) to show people how to open a pull request on GitHub and use GitKraken to do a commit on remote repositories, for most people it was their first time doing so, we were very happy giving the instructions and also helping anyone who had problems with their git setup.

At the end we let people choose an open-source project and begin working on it, here's an awesome page where you can find some open-source projects: https://up-for-grabs.net/

After the meeting 🏃🏼‍♀️

Be sure to engage with everyone who is left after the meeting has ended, not only I got to meet more people in my local community but also to invite them to collaborate in our software development community.
Also, don't forget to clean up 🧹 the space you used.
Try to upload some photos to social media during the event and after the event, by doing so people will engage with your posts and share them with other people. People who did not know about the event might get interested in Hacktoberfest and perhaps reach you with questions and ideas 💡.

(sorry for the bad quality image, I only had a vertical photo and I had to crop it 😥)

We even gave away some 3D printed git trophies using a random name picker, everyone loved them! and they are the perfect complement to your Workspace if you are using git as a versioning tool 😎

Link to the 3D model: Thingiverse

Some final tips 🤗

Be sure to invite everyone to your event 👩‍👩‍👧‍👦, even if they have no previous programming knowledge, open-source contributions are for everyone; make some emphasis on inclusion.
Get some power cords 🔌, and be sure there's electricity on the venue; people might need them to charge their computers
Be sure to arrive at least 1 hour before the start of the meeting to do some changes to the place or test equipment like the projector 📽
Get some video adapters just in case 👀, we made the mistake of believing that the projection equipment had an HDMI input, we were wrong! we almost had to request a laptop with VGA output from one of the attendants.
Surround yourself with people with the same passion, I couldn't do all of this alone, I had people helping me

Not only I learned how to host an event of this kind, but also I improved the way I talk in front of the public and I feel great leaving a positive impact on the people who attended the event.

Hopefully, this post has served you some inspiration and maybe you now want to contribute to open-source projects, if your city doesn't have a local meeting I invite you to host one, perhaps there's a lot of people who want to contribute to open source but don't know where to start.