Skip to content

Commit d0c170c

Browse files
committed
Update documentation
Add readme file. Update description.
1 parent d87e922 commit d0c170c

File tree

3 files changed

+33
-1
lines changed

3 files changed

+33
-1
lines changed

LICENSE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
The MIT License (MIT)
2+
23
Copyright (c) 2019 alexesprit
34

45
Permission is hereby granted, free of charge, to any person obtaining a copy

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## action-update-file
2+
3+
Update (i.e. commit and push) a given file on GitHub.
4+
5+
## Usage
6+
7+
The action requires GitHub token; no username or e-mail are required.
8+
9+
```yml
10+
name: Resources
11+
on: repository_dispatch
12+
jobs:
13+
resources:
14+
name: Update resources
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v1
18+
- uses: actions/setup-node@v1
19+
- name: Update resources
20+
uses: alexesprit/[email protected]
21+
with:
22+
file-path: path/to/file
23+
commit-msg: Update resources
24+
github-token: ${{ secrets.GITHUB_TOKEN }}
25+
```
26+
27+
## License
28+
29+
See the [license file][License].
30+
31+
[License]: https://github.com/alexesprit/action-update-file/blob/master/LICENSE.md

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Update file on GitHub
2-
description: Update (i.e. commit and push) a given file
2+
description: Update (i.e. commit and push) a given file on GitHub
33
author: alexesprit
44
inputs:
55
# Required

0 commit comments

Comments
 (0)