docs: how to create a GitHub Action

[johnnyreilly]

PR Checklist

• Addresses an existing open issue: fixes 📝 Documentation: Mention how to set up a GitHub Action  #1189
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

This PR provides docs on how to create a GitHub Action

[github-actions]

PR Compliance Checks Passed!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c1080ec) 94.81% compared to head (4b6095e) 94.79%.
Report is 28 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1196      +/-   ##
==========================================
- Coverage   94.81%   94.79%   -0.03%     
==========================================
  Files         104      103       -1     
  Lines        5804     5781      -23     
  Branches      492      490       -2     
==========================================
- Hits         5503     5480      -23     
  Misses        300      300              
  Partials        1        1              

Flag	Coverage Δ
create	69.93% <ø> (-0.15%)	⬇️
initialize	42.40% <ø> (+0.13%)	⬆️
migrate	69.83% <ø> (-0.06%)	⬇️
unit	75.66% <ø> (+0.07%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[JoshuaKGoldberg]

This is looking great! I left a bunch of nits because that's who I am as a person 😄 but fundamentally I really like this guide. Thanks for getting it started!

[johnnyreilly]

as predicted, my return to work has laid waste to my OSS time. I've done a few edits - where do things stand with this?

[johnnyreilly]

gah now pnpm run build is failing with out of memory:

DTS Build start
node:events:495
      throw er; // Unhandled 'error' event
      ^

Error [ERR_WORKER_OUT_OF_MEMORY]: Worker terminated due to reaching memory limit: JS heap out of memory
    at new NodeError (node:internal/errors:405:5)
    at [kOnExit] (node:internal/worker:287:26)
    at Worker.<computed>.onexit (node:internal/worker:209:20)
Emitted 'error' event on Worker instance at:
    at [kOnExit] (node:internal/worker:287:12)
    at Worker.<computed>.onexit (node:internal/worker:209:20) {
  code: 'ERR_WORKER_OUT_OF_MEMORY'
}

Node.js v18.18.2
 ELIFECYCLE  Command failed with exit code 1.

[johnnyreilly]

Fixed by export NODE_OPTIONS="--max-old-space-size=4096"

[johnnyreilly]

Okay I'm baffled now. I haven't changed anything, but I'm now seeing this failure in the tests:

/home/runner/work/create-typescript-app/create-typescript-app/create-typescript-app/knip.jsonc
Error:   5:29  error  Unexpected trailing comma  jsonc/comma-dangle

I haven't changed anything - why would the tests be failing?!

[JoshuaKGoldberg]

I haven't changed anything - why would the tests be failing?!

Yeah sorry, that was a break on main. I fixed it.

[JoshuaKGoldberg]

I think this is really close to merge, thanks! Just a few small touchups. I could make them myself but want to get your input. 🙂

[JoshuaKGoldberg]

@johnnyreilly

[johnnyreilly]

Yo @JoshuaKGoldberg! I'm back home! I think I've now looked at all the feedback - not sure though; still not quite trusting GitHub to surface stuff. Are we there?

[JoshuaKGoldberg]

Yeah this is looking great, thank you so much (as always) @johnnyreilly for dealing with my pickiness and GitHub shenanigans!

Let's get this merged 🚀

[JoshuaKGoldberg]

Test failures are unrelated. Sigh.

[JoshuaKGoldberg]

@all-contributors please add @johnnyreilly for doc.

🤖 Beep boop! This comment was added automatically by all-contributors-auto-action.
Not all contributions can be detected from Git & GitHub alone. Please comment any missing contribution types this bot missed.
...and of course, thank you for contributing! 💙

[allcontributors]

@JoshuaKGoldberg

I've put up a pull request to add @johnnyreilly! 🎉

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

[github-actions]

🎉 This is included in version v1.57.0 🎉

The release is available on:

• GitHub releases
• npm package (@latest dist-tag)

Cheers! 📦🚀