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

🛠 Tooling: Unify CI GitHub Actions workflows into a single ci.yml #1099

Closed
3 tasks done
JoshuaKGoldberg opened this issue Dec 16, 2023 · 2 comments · Fixed by #1608
Closed
3 tasks done

🛠 Tooling: Unify CI GitHub Actions workflows into a single ci.yml #1099

JoshuaKGoldberg opened this issue Dec 16, 2023 · 2 comments · Fixed by #1608
Assignees
@JoshuaKGoldberg
Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups
Milestone
General Simplific...

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

Right now, every CI workflow that runs in this repo is declared in a separate GitHub Actions workflow:

But, many of those workflows right now have the exact same on declaration:

create-typescript-app/.github/workflows/lint-spelling.yml

Lines 11 to 15 in c348a61

on:
pull_request: ~
push:
branches:
- main

We could reduce the number of workflow job files by putting all the ones with the same on in a single ci.yml file. I like the idea of having fewer files!

Additional Info

But, I don't know what the general "best practice" is for GitHub Actions is. What single recommendation has the community decided on, if there even is one? Or failing that, is there a standard recommendation that this template should go by?

Investigation required. This issue will only be marked as accepting prs if this question can be answered... somewhat definitively.
@JoshuaKGoldberg JoshuaKGoldberg added area: tooling Managing the repository's maintenance status: needs investigation Further research required...? type: cleanup Tech debt or other code/repository cleanups labels Dec 16, 2023
@JoshuaKGoldberg JoshuaKGoldberg changed the title 🛠 Tooling: Investigate whether it'd be good to unify GitHub Actions Workflows 🛠 Tooling: Unify CI GitHub Actions workflows into a single ci.yml Aug 10, 2024
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Aug 10, 2024
@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Please, send a pull request to resolve this! and removed status: needs investigation Further research required...? labels Aug 10, 2024
@JoshuaKGoldberg
Copy link
Owner Author

Yeah, I'm going to try this out. Nobody I've talked to has any single recommendation that needs to be done. And it's irksome having so many nearly-identically-structured .yml files.

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Aug 10, 2024
Merged
3 tasks
@github-actions GitHub Actions
Copy link

🎉 This is included in version v1.67.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

@JoshuaKGoldberg JoshuaKGoldberg

Labels
area: tooling Managing the repository's maintenance status: accepting prs Please, send a pull request to resolve this! type: cleanup Tech debt or other code/repository cleanups
Projects
None yet
Milestone
General Simplification
Development

Successfully merging a pull request may close this issue.

feat: unified CI jobs into one ci.yml JoshuaKGoldberg/create-typescript-app
1 participant
@JoshuaKGoldberg