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.

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

📝 Docs: Scope of application? (Suitable for GitHub Actions?) #1117

Closed
johnnyreilly opened this issue Dec 26, 2023 · 3 comments
Closed

📝 Docs: Scope of application? (Suitable for GitHub Actions?) #1117

johnnyreilly opened this issue Dec 26, 2023 · 3 comments
Assignees
Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this!

Comments

@johnnyreilly
Copy link
Collaborator

Heya!

Just a random question I wanted to ask to clarify when it's appropriate to use CTA and when it isn't. I'm writing a GitHub Action for the first time and, going by the docs, it's advised to use this template:

https://github.com/actions/typescript-action

But it got me to thinking; is there a time when you might use CTA instead for GitHub Action creation? Or is that a bit specialised? My guess is that it is a bit specialised, given all the publishing mechanism etc. but I thought I'd check.

@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this! labels Dec 26, 2023
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 26, 2023
@JoshuaKGoldberg
Copy link
Owner

Good question! For specifically GHAs I do use CTA and think it's appropriate: https://github.com/JoshuaKGoldberg/all-contributors-auto-action, https://github.com/JoshuaKGoldberg/release-it-action. It's not ideal given that there's no way yet to sync changes to a repo that's customized (#498) - but IME most repo's I've used with CTA need some customization. So that's not much worse than many others.

This is a good question in general too. Assigning to myself and marking as accepting PRs for an entry to be added to https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/docs/FAQs.md. I'll try to find some nice wordcrafting to explain the situation a bit there. Thanks!

@johnnyreilly
Copy link
Collaborator Author

Interesting! I may experiment then - will report back if I've any significant findings. Unrelated, but I'm also experimenting with using Bun for development of my GHA even though it'll use node at runtime (saves me setting up ts-node; not sure how advantageous it actually is)

@JoshuaKGoldberg JoshuaKGoldberg changed the title Scope of application? (Suitable for GitHub Actions?) Docs: Scope of application? (Suitable for GitHub Actions?) Dec 26, 2023
@JoshuaKGoldberg JoshuaKGoldberg changed the title Docs: Scope of application? (Suitable for GitHub Actions?) 📝 Docs: Scope of application? (Suitable for GitHub Actions?) Dec 26, 2023
@JoshuaKGoldberg
Copy link
Owner

Following up: I think this was resolved by the combo of:

Once this is fully migrated to create, I'll file issues for providing first-party blocks for GHA builds and other not-on-by-default things. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this!
Projects
None yet
Development

No branches or pull requests

2 participants