mirror of
https://github.com/peter-evans/dockerhub-description.git
synced 2024-11-22 03:59:34 +01:00
Update README
This commit is contained in:
parent
6de5e14b55
commit
b03d823861
1 changed files with 8 additions and 3 deletions
11
README.md
11
README.md
|
@ -41,13 +41,17 @@ If this is not the case, the path can be overridden with an environment variable
|
||||||
|
|
||||||
#### Examples
|
#### Examples
|
||||||
|
|
||||||
Updates the Docker Hub repository description whenever there is a `git push` to the `master` branch.
|
The following workflow updates the Docker Hub repository description whenever there are changes to `README.md` and the workflow file itself on the `master` branch. This workflow assumes its location to be `.github/workflows/dockerhub-description.yml`.
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
name: Update Docker Hub Description
|
name: Update Docker Hub Description
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- master
|
||||||
|
paths:
|
||||||
|
- README.md
|
||||||
|
- .github/workflows/dockerhub-description.yml
|
||||||
jobs:
|
jobs:
|
||||||
dockerHubDescription:
|
dockerHubDescription:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
@ -62,6 +66,7 @@ jobs:
|
||||||
```
|
```
|
||||||
|
|
||||||
Updates the Docker Hub repository description whenever a new release is created.
|
Updates the Docker Hub repository description whenever a new release is created.
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
name: Update Docker Hub Description
|
name: Update Docker Hub Description
|
||||||
on: release
|
on: release
|
||||||
|
@ -94,4 +99,4 @@ docker run -v $PWD:/workspace \
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT License - see the [LICENSE](LICENSE) file for details
|
[MIT](LICENSE)
|
||||||
|
|
Loading…
Reference in a new issue