search

FartLabs / jsonx

JSX runtime and compiler for composing JSON data.
https://jsonx.fart.tools
Do What The F*ck You Want To Public License
2 stars 0 forks source link

Dedicate library to GitHub workflows #10

Closed EthanThatOneKid closed 8 months ago

EthanThatOneKid commented 8 months ago

Background

We use jsonx to generate the GitHub workflows in this GitHub repository.

The scripts responsible for generating these workflows are conveniently located in the /.github/workflows/ directory, next to the workflow files they create. This co-location makes it easier to understand how the workflows are built.

However, it's important to note that this approach deviates from the typical practice of exclusively placing workflow files in the /.github/workflows/ directory. While convenient here, this might not be the standard in other repositories you encounter.

Changes

I moved the files into a new directory /lib/github_workflows/, leaving the /.github/workflows/ directory to exclusively contain the generated workflow files as expected on GitHub. This improves maintainability by separating workflow generation logic from the generated workflows themselves.

EthanThatOneKid commented 8 months ago

While convenient here, this might not be the standard in other repositories you encounter.

While placing generation scripts in /.github/workflows/ might cause minor confusion in unfamiliar repositories due to the presence of .[j|t]sx files, it doesn't introduce critical issues.