Create automation for syncing common CI/test files

instructlab / dev-docs

Developer documents for the InstructLab organization

Apache License 2.0

4 stars 32 forks source link

Create automation for syncing common CI/test files #39

Open russellb opened 7 months ago

russellb commented 7 months ago

We have a lot of files we're duplicating between several repos that are the same, or could be the same. I would like to either identify or create some automation to minimize the burden of keeping improvements and fixes in sync across repos.

Some examples:

GitHub workflow for running actionlint
GitHub workflow for running markdown lint
Makefile snippets for running common tools like actionlint, md-lint
spellcheck custom dictionary
configuration and workflows for python formatting and linting to retain common standards throughout the project

russellb commented 7 months ago

This looks like what I envisioned: https://github.com/marketplace/actions/repo-file-sync-action

It supports a PR workflow where changes are synced by posting PRs. I would want to use that approach so that every change runs through review and CI before merging the sync.

russellb commented 7 months ago

@nathan-weinberg just FYI since you've been working on establishing common CI jobs across repos. I think we could use this repo (dev-docs) as a central home for files that are shared among multiple repos, plus some automation to automatically submit PRs to sync changes to other repos.

nathan-weinberg commented 7 months ago

Relates to #12

github-actions[bot] commented 3 months ago

This issue has been automatically marked as stale because it has not had activity within 90 days. It will be automatically closed if no further activity occurs within 30 days.

nathan-weinberg commented 3 weeks ago

@danmcp @n1hility @alimaredia might we want to revisit this? if not let's close it out

danmcp commented 3 weeks ago

Need an inventory of how many identical files we have today (or files that should be identical).