Skip to content

Commit 0487fb1

Browse files
committed
Integrate with Docker Hub
1 parent 0f9bea4 commit 0487fb1

File tree

2 files changed

+55
-10
lines changed

2 files changed

+55
-10
lines changed

.github/workflows/docker.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: docker
2+
on:
3+
release:
4+
branches: [ "main" ]
5+
types: [ "published" ]
6+
tags: [ "v*" ]
7+
8+
# Actions
9+
# docker/setup-buildx-action@v3 https://github.com/marketplace/actions/docker-setup-buildx
10+
# docker/login-action@v3 https://github.com/marketplace/actions/docker-login
11+
# docker/metadata-action@v5 https://github.com/marketplace/actions/docker-metadata-action
12+
# docker/build-push-action@v6 https://github.com/marketplace/actions/build-and-push-docker-images
13+
14+
jobs:
15+
docker:
16+
name: Docker image
17+
runs-on: "ubuntu-latest"
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v4
21+
- name: Set application version
22+
run: sed -i "s#@box_git_version@#${{ github.ref_name }}#" bin/*
23+
- name: Set up Docker Buildx
24+
uses: docker/setup-buildx-action@v3
25+
- name: Login to Docker Hub
26+
uses: docker/login-action@v3
27+
with:
28+
username: ${{ secrets.DOCKERHUB_USERNAME }}
29+
password: ${{ secrets.DOCKERHUB_TOKEN }}
30+
- name: Extract metadata for Docker
31+
id: meta
32+
uses: docker/metadata-action@v5
33+
with:
34+
images: "${{ github.repository }}"
35+
tags: "type=semver,pattern={{version}}"
36+
- name: Build and push
37+
uses: docker/build-push-action@v6
38+
with:
39+
context: .
40+
push: true
41+
tags: ${{ steps.meta.outputs.tags }}
42+
labels: ${{ steps.meta.outputs.labels }}

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
[![Code Coverage][badge-coverage]][coverage]
1111
[![Violations][badge-violations]][violations]
1212
[![Total Downloads][badge-downloads]][downloads]
13+
[![Docker Downloads][badge-docker]][docker]
1314

1415
> Herramienta para obtener y generar un listado de las clasificaciones del catálogo de productos y servicios del SAT
1516
@@ -38,23 +39,23 @@ propósitos, como por ejemplo, almacenar en una base de datos.
3839
composer require phpcfdi/sat-pys-scraper
3940
```
4041

41-
## Instalación usando Docker
42+
## Ejecución usando Docker
4243

43-
Este proyecto provee un archivo `Dockerfile` para construir una imagen con todas sus dependencias.
44-
Se puede usar esta imagen para correr de forma local, para más información consulte
45-
el archivo [`README.Docker.md`](Docker.README.md).
44+
Este proyecto está integrado a Docker Hub [`phpcfdi/sat-pys-scraper`][docker] por lo que puedes ejecutarlo
45+
desde la línea de comandos:
4646

4747
```shell
48-
# clonado del proyecto
49-
git clone https://github.com/phpcfdi/sat-pys-scraper.git
50-
51-
# construcción de la imagen de Docker
52-
docker build -t sat-pys-scraper sat-pys-scraper/
48+
# obtener la imagen de docker
49+
docker pull phpcfdi/sat-pys-scraper
5350

5451
# ejecución de la herramienta
55-
docker run -it --rm sat-pys-scraper --help
52+
docker docker run -it --rm --user="$(id -u):$(id -g)" sat-pys-scraper --help
5653
```
5754

55+
Este proyecto provee un archivo `Dockerfile` para construir una imagen con todas sus dependencias.
56+
57+
Para más información y ejemplos consulte el archivo [`README.Docker.md`](Docker.README.md).
58+
5859
### Ayuda de `sat-pys-scraper` (script)
5960

6061
```text
@@ -200,6 +201,7 @@ and licensed for use under the MIT License (MIT). Please see [LICENSE][] for mor
200201
[coverage]: https://sonarcloud.io/component_measures?id=phpcfdi_sat-pys-scraper&metric=Coverage
201202
[violations]: https://sonarcloud.io/project/issues?id=phpcfdi_sat-pys-scraper&resolved=false
202203
[downloads]: https://packagist.org/packages/phpcfdi/sat-pys-scraper
204+
[docker]: https://hub.docker.com/r/phpcfdi/sat-pys-scraper
203205

204206
[badge-source]: https://img.shields.io/badge/source-phpcfdi/sat--pys--scraper-blue?logo=github
205207
[badge-php-version]: https://img.shields.io/packagist/dependency-v/phpcfdi/sat-pys-scraper/php?logo=php
@@ -211,3 +213,4 @@ and licensed for use under the MIT License (MIT). Please see [LICENSE][] for mor
211213
[badge-coverage]: https://img.shields.io/sonar/coverage/phpcfdi_sat-pys-scraper/main?logo=sonarqubecloud&server=https%3A%2F%2Fsonarcloud.io
212214
[badge-violations]: https://img.shields.io/sonar/violations/phpcfdi_sat-pys-scraper/main?format=long&logo=sonarqubecloud&server=https%3A%2F%2Fsonarcloud.io
213215
[badge-downloads]: https://img.shields.io/packagist/dt/phpcfdi/sat-pys-scraper?logo=packagist
216+
[badge-docker]: https://img.shields.io/docker/pulls/phpcfdi/sat-pys-scraper?logo=docker

0 commit comments

Comments
 (0)