Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions .github/workflows/docker-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,21 +125,3 @@ jobs:
PYLONTECH_BUILD_REVISION=${{ github.sha }}
cache-from: type=gha
cache-to: type=gha,mode=max

dockerhub-description:
name: Update Docker Hub overview
needs: image
if: github.event_name == 'push'
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6

- name: Synchronize README to Docker Hub
uses: peter-evans/dockerhub-description@e98e4d1628a5f3be2be7c231e50981aee98723ae # v4.0.0
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
repository: ${{ env.IMAGE_NAME }}
short-description: Read-only Pylontech monitoring with REST, MQTT and cell-voltage heatmaps
enable-url-completion: true
7 changes: 4 additions & 3 deletions docs/contracts/version-0.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -705,9 +705,10 @@ the health payload shall not make the container unhealthy and shall not trigger
a restart loop during a temporary external outage.

The GitHub README shall provide a complete install, verification, update and
uninstall example for the published image. The same README shall be synchronized
to the Docker Hub repository overview after a successful `main` or version-tag
image publication, using the existing Docker Hub credentials.
uninstall example for the published image. The Docker Hub repository overview
shall contain the same installation example and may be maintained manually.
Updating repository metadata shall not require granting the image-publishing
token permission to delete Docker Hub content.

The Waveshare raw TCP console is unencrypted and shall be deployed on a
dedicated isolated technical network or VLAN. Firewall policy shall permit
Expand Down
4 changes: 1 addition & 3 deletions tests/unit/test_docker_publish_workflow.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def test_docker_publish_workflow_is_valid_yaml() -> None:

assert document["name"] == "Verify and publish Docker image"
assert document["permissions"] == {"contents": "read"}
assert set(document["jobs"]) == {"verify", "image", "dockerhub-description"}
assert set(document["jobs"]) == {"verify", "image"}


def test_docker_publish_workflow_has_safe_events_and_credentials() -> None:
Expand All @@ -30,8 +30,6 @@ def test_docker_publish_workflow_has_safe_events_and_credentials() -> None:
assert "${{ secrets.DOCKERHUB_TOKEN }}" in text
assert "hrabovszki/pylontech-console" in text
assert "platforms: linux/amd64" in text
assert "Update Docker Hub overview" in text
assert "enable-url-completion: true" in text


def test_docker_publish_workflow_reserves_latest_for_stable_tags() -> None:
Expand Down