Skip to content

Commit

Permalink
minor FEAT remove lint workflow, improve action.yml (#14)
Browse files Browse the repository at this point in the history
* remove lint workflow, improve action.yml

* add more information about known issues inside the README
  • Loading branch information
SlevinWasAlreadyTaken authored Jul 21, 2023
1 parent 930f0a5 commit fd878aa
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 33 deletions.
32 changes: 0 additions & 32 deletions .github/workflows/lint.yaml

This file was deleted.

7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,18 @@ For each targeted repository:
## Configuration

See `action.yml` for more information about configuration

## Known issues

### File deletion/rename are not handled.

This action only manages to synchronize new files and updated files. Removals or renames are not handled yet.
:arrow_right: It is currently advised to blank a file that you want to remove to make it ineffective without having to remove it manually from all repositories.

### Pull Request Creations/Updates can take hours.

The action aims to respect Github API Rate (primary & secondary) Limits and to never fail. It uses a rate limiter which bases itself on HTTP headers returned by Github. The action can then take lot of time to be executed though since it waits for the rate-limit-reset time to be reached after each write operation. It can take from some seconds to some hours depending on how many repositories need to be synchronised.

## Potential Improvements

#### Handling of removed/renamed files
Expand Down
5 changes: 4 additions & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: gha-file-sync
author: "SlevinWasAlreadyTaken"
description: "Help to synchronize files between repositories by opening pull requests."
description: "Help to synchronize files from one repository to many by opening pull requests according to configured path bindings."
branding:
icon: refresh-cw
color: purple
inputs:
REPOSITORIES:
description: "Line-separated list of repositories that should receive files updates through automatic pull requests."
Expand Down

0 comments on commit fd878aa

Please sign in to comment.