https://github.com/anolilab/template-sync-action
:arrows_counterclockwise: Github action to sync repository with a template repository
https://github.com/anolilab/template-sync-action
github github-actions narrowspark sync template
Last synced: 7 months ago
JSON representation
:arrows_counterclockwise: Github action to sync repository with a template repository
- Host: GitHub
- URL: https://github.com/anolilab/template-sync-action
- Owner: anolilab
- License: mit
- Created: 2020-04-27T10:14:10.000Z (over 5 years ago)
- Default Branch: alpha
- Last Pushed: 2025-06-23T05:38:16.000Z (7 months ago)
- Last Synced: 2025-06-23T06:30:53.160Z (7 months ago)
- Topics: github, github-actions, narrowspark, sync, template
- Language: TypeScript
- Size: 1.59 MB
- Stars: 12
- Watchers: 3
- Forks: 4
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Narrowspark Template Sync Action
This [github action](https://github.com/features/actions) gives you the possibility to sync your repository with a [github template repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository).
---
---
## Example Workflow
```yml
name: 'Template Sync'
on:
schedule:
- cron: '0 8 * * *'
jobs:
sync:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: narrowspark/template-sync-action@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
git_author_name: prisis
git_author_email: d.bannert@anolilab.de
template_repository: narrowspark/php-library-template
ref: refs/heads/master
```
## Usage
```yaml
- uses: actions/template-sync@v1
with:
# Personal access token (PAT) used to fetch the repository. The PAT is configured
# with the local git config, which enables your scripts to run authenticated git
# commands. The post-job step removes the PAT. We recommend using a service
# account with the least permissions necessary. Also when generating a new PAT,
# select the least scopes necessary. [Learn more about creating and using
# encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
# Default: ${{ github.token }}
github_token: ''
# SSH key used to fetch the repository. The SSH key is configured with the local
# git config, which enables your scripts to run authenticated git commands. The
# post-job step removes the SSH key. We recommend using a service account with the
# least permissions necessary. [Learn more about creating and using encrypted
# secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
ssh-key: ''
# Known hosts in addition to the user and global host key database. The public SSH
# keys for a host may be obtained using the utility `ssh-keyscan`. For example,
# `ssh-keyscan github.com`. The public key for github.com is always implicitly
# added.
ssh-known-hosts: ''
# Whether to perform strict host key checking. When true, adds the options
# `StrictHostKeyChecking=yes` and `CheckHostIP=no` to the SSH command line. Use
# the input `ssh-known-hosts` to configure additional hosts.
# Default: true
ssh-strict: ''
# Whether to configure the token or SSH key with the local git config
# Default: true
persist-credentials: ''
# Includes your name to the commit
git_author_name: ''
# Includes your email to the commit
git_author_email: ''
# Owner of the current repository
owner: ''
# The current repository name
repo: ''
# The title of the pull request
pr_title: ''
# The message in the pull request
pr_message: ''
# The branch, tag or SHA to checkout. When checking out the repository that
# triggered a workflow, this defaults to the reference or SHA for that event.
# Otherwise, defaults to `master`.
ref: ''
template_repository: ''
# The branch, tag or SHA to checkout. When checking out the repository that
# triggered a workflow, this defaults to the reference or SHA for that event.
# Otherwise, defaults to `master`.
template_ref: ''
# Extend the default list with excluded files that shouldn't be synced.
ignore_list: ''
```