DEV Community

Cover image for GitHub Actions Hackathon 2021 Help Thread
dev.to staff for The DEV Team

Posted on • Updated on

GitHub Actions Hackathon 2021 Help Thread

If you're participating in the GitHub Actions Hackathon and you need some help with your submission, this is the place to be!

If you have any questions about how this hackathon works (ex: due dates, how to post your submission, picking a category, etc.) the DEV team will be available to help out.

If you are running into issues or get stuck when it comes to GitHub Actions and workflows, @blackgirlbytes and @mishmanners from team GitHub will be closely monitoring this thread. Be sure to tag them if you need any GitHub guidance.

Please comment below if you need asynchronous assistance with the GitHub Actions Hackathon 2021!

If you'd like to share an update on the progress you're making on your project or if you'd like to connect with other participants, please do so in the community update thread!

Discussion (73)

Collapse
cerchie profile image
Lucia Cerchie

Hey, new to Github Actions here! Curious about what it means to use an action in a workflow. Can you link to good examples and blog posts so I can start cooking up ideas?

Collapse
coderlens profile image
Lenin (he/they)

Hey, I've curated this list of resources on GitHub actions, Check it out😊
twitter.com/coderlens/status/14597...

Collapse
blackgirlbytes profile image
Rizèl Scarlett

This is great, Lenin! Thank you!

Collapse
cerchie profile image
Lucia Cerchie

ok this is awesome thank you!

Collapse
graciegregory profile image
Gracie Gregory (she/her)

@cerchie highly recommend you check out this blog from @blackgirlbytes ! 😊

Collapse
blackgirlbytes profile image
Rizèl Scarlett • Edited on

Thanks Gracie!!! @cerchie you can also check out these two blog posts:
docs.github.com/en/actions/learn-g...,
damienaicheh.github.io/github/acti...

Thread Thread
cerchie profile image
Lucia Cerchie

Thank you Rizel!!

Collapse
cerchie profile image
Lucia Cerchie

Thank you!

Collapse
star_trooper profile image
Atharva Shirdhankar

Really excited for this Hackathon 🚀🔥

But where can I register for this hackathon?

Collapse
cerchie profile image
Lucia Cerchie

looks like if you follow the submission rules here you should be good, but I'd definitely also wait on an offical DEV.to rep to answer as well dev.to/devteam/join-us-for-the-202...

Collapse
blackgirlbytes profile image
Rizèl Scarlett

Yep, you're right @cerchie by following the submission rules outlined in the doc, you should be good to go. No need to register for the hackathon. Only a submission is needed.

Thread Thread
star_trooper profile image
Atharva Shirdhankar

Ok Thanks 👍

Collapse
star_trooper profile image
Atharva Shirdhankar

Ok so we don't have to register by filling any form to participate just like other hackathon . Just write a post on Devto before 8 December with the given submission template right!

Collapse
oz9un profile image
oz9un

Hello @blackgirlbytes, @mishmanners and all participants! Thank you for organizing such a stimulating event. I've learned so many things about GitHub Actions in the last few days that I can't count.

I developed a Developers' Collaborative Playlist with using GitHub Actions and documented it:

I also referenced to my GitHub repository in this dev article. Is there anything else I need to do to participate in the competition?

Lastly, are we allowed to keep developing our project after the hackathon's deadline?
Even now, my project has been used by many people and I received excellent feedbacks and I made some fixes about that. Can I continue to do this after the competition is over? Or should we not touch the projects and stop to commit after the competition deadline?

Thanks for this amazing contest again!

Collapse
blackgirlbytes profile image
Rizèl Scarlett

Hey @oz9un ! Awesome project. As long as you've done the steps below you should be all set:

  • Document your project journey along the way with the #ActionsHackathon21 tag.
  • Submit your project as a DEV post by filling out this template to share your workflow/s (.yml) and/or code repository.
  • Please make sure the project links to the appropriate GitHub Actions repository, and includes an open source license and README.

You can continue to work on your project after submitting!

Collapse
mishmanners profile image
Michelle Mannering

Love this! And definitely keep developing the project after the hackathon ❤️

Collapse
Collapse
blackgirlbytes profile image
Rizèl Scarlett

They look eligible to me! Great work!

Collapse
0vortex profile image
TED Vortex (Teodor Eugen Duțulescu)

awesome, thank you for the quick reply!

Collapse
shehab7osny profile image
Shehab Hosny

Hi @blackgirlbytes and @mishmanners

I have a technical question regarding GitHub Actions.

Is it applicable to cache checkout actions?
I mean, if I use multiple workflows that do require to checkout my repository, should I apply the same process each and every time I execute any of these workflows or does the cache action provide any alternative?

I know that caching the checkout isn't the right approach as we do need a new and clean version of the repository after each and every commit, but I also do think that cloning the same repository at each workflow is a little bit time consuming and doesn't make sense. So, what I'm really searching for is a way to only apply checkout once across multiple workflows and load the checkout out directory whenever needed.

I did some research on this topic but I found nothing except this unanswered discussion:
github.com/actions/checkout/discus...

Any help would be appreciated...

Collapse
blackgirlbytes profile image
Rizèl Scarlett • Edited on

Hey @shehab7osny ! @mishmanners and I did a bit of research, and it looks like for the source code itself we would generally recommend the checkout is most appropriate. By default, it only pulls the latest commit rather than full history so the amount of data being transferred is already reasonably low. You can save significant time by enabling dependency caching when setting up your environment (such as Node or Python). See the relevant setup action (such as github.blog/changelog/2021-07-02-g...) and look for the ‘cache:’ attribute.

Collapse
mishmanners profile image
Michelle Mannering

I'm checking in on this and will be back to you soon 😄

Collapse
shehab7osny profile image
Shehab Hosny

Thank you a lot Michelle for your efforts! Take your time 😄

Thread Thread
mishmanners profile image
Michelle Mannering

See @blackgirlbytes ' amazing response from our team above 😄

Thread Thread
shehab7osny profile image
Shehab Hosny

Many thanks for you @mishmanners and @blackgirlbytes ! Much appreciated... I didn't know that actions/checkout@v2 only pulls the latest commit rather than full history. This will definitely help! However, I'm building a C++ project with a varying customizable environment. So, it wouldn't be easy to cache the whole environment, but I will give it a shot anyways. One more time, thank you a lot for the help 😊

Collapse
geopjr profile image
GeopJr

Hey @blackgirlbytes & @mishmanners ! 👋

I'm having a GitHub related issue that is preventing me from applying to the hackathon.
I've already filed a ticket (#1415845) but I don't think it'll be fixed in time for me to participate...

The gist is that I'm trying to publish my action to the marketplace but the checkbox when drafting a new release does not appear (the "Publish this Action to Marketplace" banner on the repo does however).

Collapse
blackgirlbytes profile image
Rizèl Scarlett • Edited on

Hi @geopjr ! Apologies that you're having this issue. I will try to flag your issue to the right group. The good news is you don't have to publish your action to the marketplace to participate in the Hackathon. In the rules outlined, here's all you need to do:

  • Document your project journey along the way with the #ActionsHackathon21 tag.
  • Submit your project as a DEV post by filling out this template to share your workflow/s (.yml) and/or code repository.
  • Please make sure the project links to the appropriate GitHub Actions repository, and includes an open source license and README.

Review these guidelines for more info: dev.to/devteam/join-us-for-the-202...

Collapse
anthonyalvarez profile image
Anthony E. Alvarez

Hello Rizèl,

Can the code and github actions YAML files be the same repository or should there be two separate repos?

Will the Github Actions Hackathon project DEV post be publicly available and searchable at this website immediately after submission?

Please advise.
Thank you. Regards.

Thread Thread
mishmanners profile image
Michelle Mannering

Can be the same repo. Just make sure publicly available and link it into your DEV post. Hope you went well with the submission ❤️

Thread Thread
anthonyalvarez profile image
Anthony E. Alvarez

Hello from New York City!

My GitHub Actions Hackathon 2021 was completed on time.
Another DEV.to community member noted a typo in my post.
If my post is edited to correct the typo, will the post's time stamp be updated and possibly disqualify my hackathon submission?

Thank you.

Collapse
shehab7osny profile image
Shehab Hosny • Edited on

Hi @blackgirlbytes and @mishmanners

First of all, thank you a lot for organizing such a great hackathon, I really do appreciate it!
Okay so now I have a doubt regarding the hackathon, the following paragraph is mentioned in the original post:

For this year’s hackathon, we’re encouraging participants to utilize existing GitHub Actions to create workflows that make sense in the real world. While you are free to create a new Action, the emphasis of this contest is to create practical and interesting solutions other developers can utilize to solve problems with open source.

Does this mean that workflows that use actions/Any_Action in their jobs are preferred than others that use custom-made actions such as shehab7osny/Any_Action, right? or does it mean to stick to the Actions currently available on the GitHub Actions' marketplace without the need to develop new ones?

Collapse
mishmanners profile image
Michelle Mannering • Edited on

The idea is you'll need to either create an Action or workflow FROM an existing Action (preferred), or create a new Action entirely. Look at what's on the Actions marketplace and build on one of those. Don't forget to write a blog post about it 😄

Collapse
shehab7osny profile image
Shehab Hosny

Hi @mishmanners
Thank you a lot for replying! I beg your pardon, but I find the phrase create an Action FROM an existing Action a little bit conflicting with the phrase in the original post utilize existing GitHub Actions to create workflows. As in your comment, it is suggested to create an Action while in the original post it is suggested to create a Workflow.

As the GitHub Actions Documentation states, Actions are “individual tasks that you can combine to create jobs and customize your workflow”. On the other hand, Workflows are “custom automated processes that you can set up in your repository to build, test, package, release, or deploy any project on GitHub”

So, am I supposed to create a Workflow from an existing Action or create an Action FROM an existing Action?

Thank you a lot for your help @blackgirlbytes and @mishmanners
I'm so sorry for any disturbance caused.

Thread Thread
mishmanners profile image
Michelle Mannering

Feel free to create either one; an Action or a workflow. As long as it's new, and utilises an existing Action, and you write a blog post about it 😄

Collapse
blackgirlbytes profile image
Rizèl Scarlett

If anyone has questions, I'm happy to help!

Collapse
simeydk profile image
Simey de Klerk

Hi @graciegregory & friends
This is an awesome idea!
I contributed a github action to "lint" Podcast transcripts to the Changelog podcast, and wrote a blog post about it on the Changelog blog. Can I repurpose that here? Would it be a valid submission?

Link on the changelog blog:
changelog.com/posts/auto-improved-...

Collapse
mishmanners profile image
Michelle Mannering

If you created a new action or workflow, then definitely feel free to include 😄

Collapse
star_trooper profile image
Atharva Shirdhankar

Will it be solo or team work(4 members)base hackathon?

Collapse
riocantre profile image
Rio Cantre

Same question for me as well. Up!!

Collapse
blackgirlbytes profile image
Rizèl Scarlett

Hey @star_trooper and @riocantre , solo entries are allowed and so are group entries. I believe the preference is to keep it under 4 members per team. You can learn more about the hackathon rules at this link: dev.to/page/official-hackathon-rules

Thread Thread
star_trooper profile image
Atharva Shirdhankar

Thanks 👍

Thread Thread
riocantre profile image
Rio Cantre

Thank you!

Collapse
techwatching profile image
Alexandre

Do existing blog post and workflow (just made ond in August matching the contest) count ? Or should I write another blog post ?

Collapse
blackgirlbytes profile image
Rizèl Scarlett

I'm copying and pasting @mishmanners answer right here because I think it was a great one!!!

"This hackathon is about leveraging existing Actions. If you created a workflow a few months back, then it's an existing Action.

I'd recommend building on this existing Action you already created and submitting that along with your blog post. You could mention why you created the existing Action, and then how you built on that during this hackathon.

Good luck ❤️"

Collapse
mishmanners profile image
Michelle Mannering

Only new blog posts will be accepted. We are also encouraging people to create new workflows from existing Actions.

Collapse
anthonyalvarez profile image
Anthony E. Alvarez

Hello from New York City,

When there are multiple YAML files for Github Actions, what determines the sequence of which YAML file is to run first, second, third and so on? Is it advisable to put all actions in a single YML file?

Thank you..

Collapse
blackgirlbytes profile image
Rizèl Scarlett

Hey @anthonyalvarez , I would advise you to put them into a single file. There's nothing that determines the sequence across multiple file. I don't know your exact use case, but maybe reusable workflows would be helpful here. You can find out more about reusable workflows at this link: dev.to/github/github-actions-you-c...

Collapse
anthonyalvarez profile image
Anthony E. Alvarez

Hello from New York City,

This is my first attempt to make a Github Action but have some questions about Github actions for local development and testing.

  1. Can Github actions be created in a dev branch on a local repo on my PC and then uploaded to Github.com website?

  2. Can the Github actions be tested on a dev branch on the Github.com website?

  3. Finally can the Github actions in dev be merged into the master branch or is it best to create Action files on master branch using Github c.com website and avoid using dev branches and eventually merging with master?

Thank you.

Collapse
blackgirlbytes profile image
Rizèl Scarlett

Hi Anthony!!! Happy to answer these questions.

  1. Yes, you can create actions locally and then upload them to GitHub.com
  2. Yes, you can test them on a dev branch on GitHub.com
  3. You can treat GitHub Actions the same way you would treat your code. Feel free to add it to a dev branch and then merge it to your default branch afterwards.

Here's a reference on how to build your first workflow: dev.to/github/github-actions-build...

Collapse
codewithpom profile image
Padmashree Jha

How shall we now get the sticker pack.

Collapse
paxf3e profile image
Pallav Saxena • Edited on

Hello, I wanted to enquire, is it possible for anyone from the Dev/Organising Team to please check if I have made my submission for the hackathon correctly?
dev.to/paxf3e/deploy-to-heroku-by-...
This is the link to my submission

Collapse
stphnwlsh profile image
Stephen Walsh

How do you check if your entry is valid?
dev.to/stphnwlsh/dotnet-outdated-i...
I put something together but will it be rejected if it's not in the right format?

Collapse
blackgirlbytes profile image
Rizèl Scarlett

As long as it's leveraging an existing action, it's valid. I gave it a quick once over, and it looks great to me!

Collapse
stphnwlsh profile image
Stephen Walsh

Thanks!!!

Collapse
codewithpom profile image
Padmashree Jha

@blackgirlbytes Do you have any example for any workflow library.

Collapse
blackgirlbytes profile image
Rizèl Scarlett
Collapse
jsoref profile image
Josh Soref

If I have an existing workflow which is helpful to others, is that an ok starting point, or do I need to start from scratch to be elligible?
github.com/check-spelling/spell-ch...

Collapse
graciegregory profile image
Gracie Gregory (she/her)

Hi there! See Michelle's response to a similar question here 😃 dev.to/mishmanners/comment/1jji1

Collapse
priyanshu profile image
Priyanshu Agarwal

Can we submit the workflow which was made a few months back?

Collapse
mishmanners profile image
Michelle Mannering

This hackathon is about leveraging existing Actions. If you created a workflow a few months back, then it's an existing Action.

I'd recommend building on this existing Action you already created and submitting that along with your blog post. You could mention why you created the existing Action, and then how you built on that during this hackathon.

Good luck ❤️

Collapse
mishmanners profile image
Michelle Mannering

Here to help if people need!

Collapse
sathyapriyaasketch profile image
sathya_priyaa

can someone share the link of registration ?

Collapse
blackgirlbytes profile image
Rizèl Scarlett

Hi @sathyapriyaasketch ! There's no registration form. You just have to submit your entry before December 8th by following the Hackathon rules outlined here: dev.to/devteam/join-us-for-the-202...

Collapse
codewithpom profile image
Padmashree Jha

@blackgirlbytes how shall we get the swags now and happy new year 😀

Collapse
aryanarayantiwari profile image
Arya Narayan Tiwari

As this year's theme is leveraging existing workflows does it mean that I can tweak an existing worflow and submit it ?even if it's small changes,would it be counted as a valid submission ?

Collapse
blackgirlbytes profile image
Rizèl Scarlett

Hi, yes! You can use and tweak and existing workflow for submission. You can also gain some inspiration from this video regarding creating reusable workflows: youtube.com/watch?v=lRypYtmbKMs

Collapse
thomasbnt profile image
Thomas Bnt

Hello, I have a question. GitHub Actions can create and/or edit a comment ?

Collapse
avinal profile image
Avinal Kumar

Are multiple submissions allowed??

Collapse
blackgirlbytes profile image
Rizèl Scarlett

Yes, multiple submissions are allowed!

Collapse
anthonyalvarez profile image
Anthony E. Alvarez • Edited on

Hello, Is there a simple example of how to combine two github actions from the Marketplace using the same runner in sequence and parallel? Thank you.

Collapse
cerchie profile image
Lucia Cerchie

Here's my submission, thanks for the help! dev.to/cerchie/marvel-ize-your-rep...

Collapse
epassaro profile image
epassaro

What's the difference between the sections "My Workflow" and "Yaml File or Link to Code" in the submission post? It's not clear for me.

Collapse
mishmanners profile image
Michelle Mannering • Edited on

They are both the same. In your submission, I would recommend linking to your entire repository so we can see your license and README file, and separately linking to your workflow/yaml file so everyone can see the amazing Action/workflow you build 😄

Collapse
jyotikm29 profile image
JyotiKM29

Hey ! I am new there , I just know About Github Action, Can I also participate in it.