Skip to content

Commit 21542d3

Browse files
committed
Merge branch 'main' of https://github.com/tj-python/github-yaml-deploy into main
2 parents 52c1510 + 5c64bd6 commit 21542d3

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,43 @@
44
# github-deploy
55

66
## Problem
7-
Using [poly repositories](https://github.com/joelparkerhenderson/monorepo_vs_polyrepo#what-is-polyrepo) to manage projects can introduce a number challenges one of which is maintaining consistency across multiple repositories for files like shared configurations in your organization.
7+
Using [poly repositories](https://github.com/joelparkerhenderson/monorepo_vs_polyrepo#what-is-polyrepo) to manage projects ?
8+
9+
This can introduce a number challenges one of which is maintaining consistency across multiple repositories for files like shared configurations in your organization without introducing git submodules.
810

911

1012
> For example adding a github action or maintaing a consistent pull request template accross your organization.
1113
1214

1315
## Usage
1416

15-
#### Creating or Updating files on github
17+
### Creating or Updating files on github
1618

17-
`github-deploy`
1819

1920
```shell script
20-
github-deploy --org [org] --token [PAT_TOKEN] --dest [LOCATION TO UPLOAD FILE] --source [SOURCE FILE LOCATION]
21+
github-deploy update --org [org] --token [PAT_TOKEN] --dest [LOCATION TO UPLOAD FILE] --source [SOURCE FILE LOCATION]
2122
```
2223

2324
Example:
2425

2526
```shell script
26-
github-deploy --org tj-actions --token [PAT_TOKEN] --dest '.github/workflows/auto-approve.yml' --source auto-approve.yml
27+
github-deploy update --org tj-actions --token [PAT_TOKEN] --dest '.github/workflows/auto-approve.yml' --source auto-approve.yml
2728
```
2829

2930
> NOTE: `auto-approve.yml` is located on your local system.
3031
3132

32-
#### Deleting files on github
33+
### Deleting files on github
3334

34-
`github-delete`
3535

3636
```shell script
37-
github-delete --org [org] --token [PAT_TOKEN] --dest [LOCATION TO DELETE]
37+
github-deploy delete --org [org] --token [PAT_TOKEN] --dest [LOCATION TO DELETE]
3838
```
3939

4040
Example:
4141

4242
```shell script
43-
github-delete --org tj-actions --token [PAT_TOKEN] --dest '.github/auto-approve.yml'
43+
github-deploy delete --org tj-actions --token [PAT_TOKEN] --dest '.github/auto-approve.yml'
4444
```
4545

4646

0 commit comments

Comments
 (0)