mirror of
https://github.com/redhat-actions/push-to-registry.git
synced 2025-02-23 10:31:22 +01:00
93 lines
No EOL
2.3 KiB
Markdown
93 lines
No EOL
2.3 KiB
Markdown
# push-to-registry
|
|
|
|
Push-to-registry is a GitHub Action for pushing an OCI-compatible image to any registry.
|
|
|
|
## Action Inputs
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Action input</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tr>
|
|
<td>image-to-push:/td>
|
|
<td>(Required) Name of the image you want to push. Most likely the name you used to create it in the previous step.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>tag</td>
|
|
<td>(Optional) Tag of the image. Default value: latest.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>registry</td>
|
|
<td>(Required) Registry where to push the image. E.g https://quay.io/username</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>username</td>
|
|
<td>(Required) Username to use as credential to authenticate to the registry</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>password</td>
|
|
<td>(Required) Password to use as credential to authenticate to the registry</td>
|
|
</tr>
|
|
</table>
|
|
|
|
## Examples
|
|
|
|
The example below shows how the `push-to-registry` action can be used to push an image created by the [`buildah-action`](https://github.com/redhat-actions/buildah-action) in an early step.
|
|
|
|
```
|
|
name: CI
|
|
on: [push]
|
|
|
|
jobs:
|
|
build:
|
|
name: Build image
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v2
|
|
|
|
- name: Maven
|
|
run: |
|
|
cd ${GITHUB_WORKSPACE}
|
|
mvn package
|
|
- name: Build Action
|
|
uses: redhat-actions/buildah-action@0.0.1
|
|
with:
|
|
new-image-name: petclinic
|
|
content: |
|
|
target/spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar
|
|
entrypoint: |
|
|
java
|
|
-jar
|
|
spring-petclinic-2.3.0.BUILD-SNAPSHOT.jar
|
|
port: 8080
|
|
- name: Push To Quay
|
|
uses: redhat-actions/push-to-registry@0.0.1
|
|
with:
|
|
image-to-push: petclinic
|
|
registry: ${{ secrets.QUAY_REPO }}
|
|
username: ${{ secrets.QUAY_USERNAME }}
|
|
password: ${{ secrets.QUAY_PASSWORD }}
|
|
```
|
|
|
|
|
|
## Contributing
|
|
|
|
This is an open source project open to anyone. This project welcomes contributions and suggestions!
|
|
|
|
## Feedback & Questions
|
|
|
|
If you discover an issue please file a bug in [GitHub issues](https://github.com/redhat-actions/push-to-registry/issues) and we will fix it as soon as possible.
|
|
|
|
## License
|
|
|
|
MIT, See [LICENSE](https://github.com/redhat-actions/push-to-registry/blob/main/LICENSE.md) for more information. |