Skip to content

Add template sync workflow for automated repository synchronization #74

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

Merged
Zahnentferner merged 4 commits into from
Feb 24, 2026
Merged

Add template sync workflow for automated repository synchronization #74

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e0d37c
Add template sync workflow for automated repository synchronization
kpj2006 Feb 21, 2026
0283f13
improvement
kpj2006 Feb 21, 2026
ba739d9
Add .templatesyncignore to exclude specific files from template sync
kpj2006 Feb 21, 2026
775b658
Add link to documentation for editing .templatesyncignore
kpj2006 Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/template-sync.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Template Sync
Copy link
Contributor

@Zahnentferner Zahnentferner Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where do we specify which files should be kept in sync?

Take the readme file for instance. A new repo using the template repo should modify the readme for its own needs. If the readme template in the template repo gets updated, it is not clear how the readme in the new repo should be synchronized...

Copy link
Contributor Author

@kpj2006 kpj2006 Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bydefault it sync all file in template repo except in .github/workflows one due to github policy

for that i have also created a issue:#76
even if you want to ignore a file mention it specially

Image

Once the workflow is triggered, it will compare the target repository with the source, and will open a Pull Request on the target repository if there are any differences You can see how it looks like in the Pull Requests #1 and #2 from dotdc/terraform-module-example.

have a look on : https://github.com/AndreasAugustin/actions-template-sync?tab=readme-ov-file#ignore-files

Copy link
Contributor

@Zahnentferner Zahnentferner Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then let's already add .templatesyncignore file to the template repo, to make it ignore files like README.md, which are supposed to be customized in the destination repo and then not overwritten/synced by the tempalte repo again.


on:
# cronjob trigger - runs monthly on the 1st at midnight
schedule:
- cron: "0 0 1 * *"
workflow_dispatch:
jobs:
repo-sync:
runs-on: ubuntu-latest
if: github.repository != 'AOSSIE-Org/Template-Repo'
# https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs
permissions:
contents: write
pull-requests: write

steps:
# Check out the repository
- name: Checkout
uses: actions/checkout@v4
# https://github.com/actions/checkout#usage
# uncomment if you use submodules within the repository
# with:
# submodules: true

- name: actions-template-sync
uses: AndreasAugustin/actions-template-sync@v2
with:
source_repo_path: AOSSIE-Org/Template-Repo
upstream_branch: main # defaults to main
pr_labels: template_sync,auto_pr # defaults to template_sync
source_gh_token: ${{ secrets.GITHUB_TOKEN }}
is_pr_cleanup: true # for not open multiple PRs
Loading