Skip to content

Commit 257ab64

Browse files
committed
docs: Update README with new features
1 parent c9e9117 commit 257ab64

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,49 @@ Normal variables are basic strings. In some cases you want to use JSON objects o
5959
{{/each}}
6060
```
6161

62+
### Ignoring Files
63+
64+
You can exclude specific template files from being synced using the `ignore-files` input. Paths are relative to the `templates/` directory.
65+
66+
```yaml
67+
- uses: beam-community/actions-sync@v1
68+
with:
69+
sync-repository: beam-community/common-config
70+
ignore-files: |
71+
.github/workflows/release.yml
72+
.tool-versions
73+
```
74+
75+
## Configuration File
76+
77+
You can configure actions-sync via a `.github/actions-sync.yml` file in your target repository. This allows each repository to customize sync behavior without modifying the workflow.
78+
79+
```yaml
80+
# .github/actions-sync.yml
81+
commit-branch: chore/sync-config
82+
commit-message: "chore: update synced files"
83+
pr-enabled: false
84+
pr-title: "chore: sync configuration files"
85+
ignore-files:
86+
- .github/workflows/ci.yaml
87+
- .credo.exs
88+
```
89+
90+
All fields are optional and serve as fallbacks when the corresponding action inputs are not specified. Available options:
91+
92+
| Field | Description |
93+
|-------|-------------|
94+
| `commit-branch` | Branch name for sync commits |
95+
| `commit-message` | Commit message for changes |
96+
| `commit-user-email` | Git user email for commits |
97+
| `commit-user-name` | Git user name for commits |
98+
| `ignore-files` | List of template files to skip |
99+
| `pr-body` | Pull request body text |
100+
| `pr-enabled` | Whether to create a PR (`true`/`false`) |
101+
| `pr-labels` | Labels to apply to the PR |
102+
| `pr-review-users` | Users to request review from |
103+
| `pr-title` | Pull request title |
104+
62105
## Alternatives
63106

64107
There are many other git sync type actions currently on GitHub, however most of them only handle static files. This action was created where some files are dynamic and should be templated or scripted before synced.

0 commit comments

Comments
 (0)