Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📝 Documentation: Mention how to set up a GitHub Action #1189

Closed
2 tasks done
JoshuaKGoldberg opened this issue Jan 4, 2024 · 8 comments · Fixed by #1196
Closed
2 tasks done

📝 Documentation: Mention how to set up a GitHub Action #1189

JoshuaKGoldberg opened this issue Jan 4, 2024 · 8 comments · Fixed by #1196
Assignees
@johnnyreilly
Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Jan 4, 2024 •
edited

Bug Report Checklist

Overview

I have two GitHub Actions repos built on this template:

In JoshuaKGoldberg/all-contributors-auto-action#170 I had the pleasure of learning the hard way that dist/ changes aren't built automatically (pnpm build:release). I'd never gotten around to setting that up to happen automatically.

Filing this issue to track adding it to this template.

Additional Info

This is related to #1175.
@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to docs type: feature New enhancement or request status: accepting prs Please, send a pull request to resolve this! labels Jan 4, 2024
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Jan 4, 2024
@johnnyreilly
Copy link
Sponsor Collaborator

I was going to volunteer to do this given my Schemar work - but happy to review what you do instead

@JoshuaKGoldberg
Copy link
Owner Author

Right! I knew it was top of mind for some reason 😄 all yours!

@JoshuaKGoldberg
Copy link
Owner Author

@all-contributors please add @johnnyreilly for maintenance.

🤖 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 allcontributors bot mentioned this issue Jan 5, 2024
Merged
@allcontributors AllContributors
Copy link
Contributor

@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.

@johnnyreilly
Copy link
Sponsor Collaborator

So before I kick off on this, I want to get a sense of what we want. Is the idea this is a document which describes how to migrate CTA to being able to work as a GitHub Action? Or did you have something else in mind?

JoshuaKGoldberg pushed a commit that referenced this issue Jan 5, 2024
@allcontributors
docs: add johnnyreilly as a contributor for maintenance (#1191)
73ba04a 
Adds @johnnyreilly as a contributor for maintenance.

This was requested by JoshuaKGoldberg [in this
comment](#1189 (comment))

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
@JoshuaKGoldberg
Copy link
Owner Author

JoshuaKGoldberg commented Jan 5, 2024 •
edited

Good question... I was thinking a good start would be a FAQ entry akin to How can I add dual CommonJS / ECMAScript Modules emit?. Then longer term we can:

  1. Add more FAQ entries like that as other types of packages come up
  2. Eventually have individual guides on a more comprehensive website (📝 Documentation: Make & link to a docs website #1193)

What do you think?

@johnnyreilly
Copy link
Sponsor Collaborator

Yeah that feels like a good iteration plan. By virtue of being part of the FAQs, I'll have to be terse. That could be good though

@johnnyreilly johnnyreilly mentioned this issue Jan 6, 2024
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Jan 28, 2024
@johnnyreilly @JoshuaKGoldberg
docs: how to create a GitHub Action (#1196)
1e99b68 
<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 💖.
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [x] Addresses an existing open issue: fixes #1189
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

<!-- Description of what is changed and how the code change does that.
-->
This PR provides docs on how to create a GitHub Action

---------

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.57.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnnyreilly johnnyreilly

Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: how to create a GitHub Action JoshuaKGoldberg/create-typescript-app
2 participants
@johnnyreilly @JoshuaKGoldberg