mirror of
https://github.com/peter-evans/dockerhub-description.git
synced 2024-11-24 13:09:33 +01:00
98 lines
4.1 KiB
Markdown
98 lines
4.1 KiB
Markdown
# Docker Hub Description
|
|
[](https://github.com/marketplace/actions/docker-hub-description)
|
|
[](https://circleci.com/gh/peter-evans/dockerhub-description/tree/master)
|
|
|
|
A GitHub action to update a Docker Hub repository description from `README.md`.
|
|
|
|
This is useful if you `docker push` your images to Docker Hub. It provides an easy, automated way to keep your Docker Hub repository description in sync with your GitHub repository `README.md` file.
|
|
|
|
## Usage
|
|
|
|
```yml
|
|
- name: Docker Hub Description
|
|
uses: peter-evans/dockerhub-description@v2.0.0
|
|
env:
|
|
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
|
|
DOCKERHUB_REPOSITORY: peterevans/dockerhub-description
|
|
```
|
|
|
|
#### Required environment variables
|
|
|
|
- `DOCKERHUB_USERNAME` - Docker Hub username
|
|
- `DOCKERHUB_PASSWORD` - Docker Hub password
|
|
- `DOCKERHUB_REPOSITORY` - The Docker Hub repository to update in the format `<namespace>/<name>`
|
|
|
|
Note that `DOCKERHUB_REPOSITORY` may also be passed as a secret if considered sensitive.
|
|
|
|
#### Optionally specifying the file path
|
|
|
|
The action assumes that there is a file called `README.md` located at the root of the repository.
|
|
If this is not the case, the path can be overridden with an environment variable.
|
|
|
|
```yml
|
|
- name: Docker Hub Description
|
|
uses: peter-evans/dockerhub-description@v2.0.0
|
|
env:
|
|
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
|
|
DOCKERHUB_REPOSITORY: peterevans/dockerhub-description
|
|
README_FILEPATH: ./some-path/README.md
|
|
```
|
|
|
|
#### Examples
|
|
|
|
Updates the Docker Hub repository description whenever there is a `git push` to the `master` branch.
|
|
```yml
|
|
name: Update Docker Hub Description
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
jobs:
|
|
dockerHubDescription:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
- name: Docker Hub Description
|
|
uses: peter-evans/dockerhub-description@v2.0.0
|
|
env:
|
|
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
|
|
DOCKERHUB_REPOSITORY: peterevans/dockerhub-description
|
|
```
|
|
|
|
Updates the Docker Hub repository description whenever a new release is created.
|
|
```yml
|
|
name: Update Docker Hub Description
|
|
on: release
|
|
jobs:
|
|
dockerHubDescription:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
- name: Docker Hub Description
|
|
uses: peter-evans/dockerhub-description@v2.0.0
|
|
env:
|
|
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
|
|
DOCKERHUB_REPOSITORY: peterevans/dockerhub-description
|
|
```
|
|
|
|
## Using the Docker image independently of GitHub Actions
|
|
|
|
The image can be executed in other environments independently of GitHub Actions.
|
|
Simply volume mount the location of the `README.md` file to the container and set environment variables as follows.
|
|
|
|
```bash
|
|
docker run -v $PWD:/workspace \
|
|
-e DOCKERHUB_USERNAME='user1' \
|
|
-e DOCKERHUB_PASSWORD='xxxxx' \
|
|
-e DOCKERHUB_REPOSITORY='user1/my-docker-image' \
|
|
-e README_FILEPATH='/workspace/README.md' \
|
|
peterevans/dockerhub-description:2.0.0
|
|
```
|
|
|
|
## License
|
|
|
|
MIT License - see the [LICENSE](LICENSE) file for details
|