https://github.com/actionhippie/pushrm
Action to push a README to DockerHub, Quay or Harbor
https://github.com/actionhippie/pushrm
action github
Last synced: 3 months ago
JSON representation
Action to push a README to DockerHub, Quay or Harbor
- Host: GitHub
- URL: https://github.com/actionhippie/pushrm
- Owner: actionhippie
- License: apache-2.0
- Created: 2021-07-30T21:10:06.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2026-04-06T09:06:40.000Z (3 months ago)
- Last Synced: 2026-04-06T11:14:47.487Z (3 months ago)
- Topics: action, github
- Language: Nix
- Homepage:
- Size: 213 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# pushrm
[](https://github.com/actionhippie/pushrm) [](https://github.com/actionhippie/pushrm/actions/workflows/docker.yml)
[GitHub Action](https://github.com/features/actions) to push a README to DockerHub, Quay or Harbor.
## Usage
```yml
name: Example
on:
- push
- pull_request
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actionhippie/pushrm@v1
with:
provider: dockerhub
target: webhippie/alpine
description: Docker image for Alpine
username: octocat
password: p455w0rd
```
## Inputs
### `username`
Username for DockerHub or Harbor
### `password`
Password for DockerHub or Harbor
### `apikey`
API key only used for Quay.io
### `provider`
Used provider like dockerhub, harbor or quay
### `description`
Short description to be set on the registry
### `readme`
Path to another README like README.container.md
### `target`
Target image to write the README to
## Outputs
None
## Security
If you find a security issue please contact thomas@webhippie.de first.
## Contributing
Fork -> Patch -> Push -> Pull Request
## Authors
* [Thomas Boerger](https://github.com/tboerger)
## License
Apache-2.0
## Copyright
```console
Copyright (c) 2021 Thomas Boerger
```