Skip to content

Commit 7788099

Browse files
committed
ci: fix docker hub readme
1 parent 0bc3c4e commit 7788099

2 files changed

Lines changed: 32 additions & 5 deletions

File tree

‎.github/workflows/docker-publish.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212

1313
steps:
1414
- name: Check out the repo
15-
uses: actions/checkout@v3
15+
uses: actions/checkout@v5
1616

1717
- name: Extract package version
1818
id: package
@@ -27,13 +27,13 @@ jobs:
2727
PY
2828
2929
- name: Log in to Docker Hub
30-
uses: docker/login-action@v3
30+
uses: docker/login-action@v4
3131
with:
3232
username: ${{ secrets.DBP_DOCKERHUB_CREDENTIAL_USERNAME }}
3333
password: ${{ secrets.DBP_DOCKERHUB_CREDENTIAL_TOKEN_PUSHIMAGES }}
3434

3535
- name: Build and push Docker image
36-
uses: docker/build-push-action@v6
36+
uses: docker/build-push-action@v7
3737
with:
3838
context: .
3939
push: true
@@ -42,10 +42,10 @@ jobs:
4242
dbpedia/databus-python-client:${{ steps.package.outputs.version }}
4343
4444
- name: Update Docker Hub overview
45-
uses: peter-evans/dockerhub-description@v4
45+
uses: peter-evans/dockerhub-description@v5
4646
with:
4747
username: ${{ secrets.DBP_DOCKERHUB_CREDENTIAL_USERNAME }}
4848
password: ${{ secrets.DBP_DOCKERHUB_CREDENTIAL_TOKEN_PUSHIMAGES }}
4949
repository: dbpedia/databus-python-client
5050
short-description: Command-line and Python client for downloading, deploying and deleting datasets on DBpedia Databus.
51-
readme-filepath: ./README.md
51+
readme-filepath: ./doc/docker/README.md

‎doc/docker/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Databus Python Client
2+
3+
Command-line and Python client for downloading, deploying, deleting, and
4+
manifesting datasets on the DBpedia Databus.
5+
6+
## Usage
7+
8+
```bash
9+
docker run --rm -v $(pwd):/data dbpedia/databus-python-client --help
10+
docker run --rm -v $(pwd):/data dbpedia/databus-python-client [download|deploy|delete|manifest|workflow] --help
11+
```
12+
13+
## Version Tags
14+
15+
The Docker image is published as `latest` and with the package version from
16+
`pyproject.toml`, for example:
17+
18+
```bash
19+
docker pull dbpedia/databus-python-client:latest
20+
docker pull dbpedia/databus-python-client:1.0.0
21+
```
22+
23+
## Links
24+
25+
- Source code: https://github.com/dbpedia/databus-python-client
26+
- Releases: https://github.com/dbpedia/databus-python-client/releases
27+
- DBpedia Databus: https://databus.dbpedia.org

0 commit comments

Comments
 (0)