{"id":13823072,"url":"https://github.com/christian-korneck/update-container-description-action","last_synced_at":"2025-09-05T16:37:27.515Z","repository":{"id":65155392,"uuid":"278738207","full_name":"christian-korneck/update-container-description-action","owner":"christian-korneck","description":"github action to update a Docker Hub, Quay or Harbor repository description from a README file","archived":false,"fork":false,"pushed_at":"2022-11-01T20:23:05.000Z","size":3,"stargazers_count":29,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-30T12:42:51.765Z","etag":null,"topics":["cd","ci","container-registry","containers","docker","dockerhub","github","github-actions","github-workflow","harbor","quay"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/christian-korneck.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-10T21:39:13.000Z","updated_at":"2025-06-26T22:27:52.000Z","dependencies_parsed_at":"2023-01-05T13:18:10.115Z","dependency_job_id":null,"html_url":"https://github.com/christian-korneck/update-container-description-action","commit_stats":{"total_commits":2,"total_committers":1,"mean_commits":2.0,"dds":0.0,"last_synced_commit":"cf2977b0f3d189227f140ecbc6402c5a042b34e4"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/christian-korneck/update-container-description-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christian-korneck%2Fupdate-container-description-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christian-korneck%2Fupdate-container-description-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christian-korneck%2Fupdate-container-description-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christian-korneck%2Fupdate-container-description-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/christian-korneck","download_url":"https://codeload.github.com/christian-korneck/update-container-description-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christian-korneck%2Fupdate-container-description-action/sbom","scorecard":{"id":280663,"data":{"date":"2025-08-11","repo":{"name":"github.com/christian-korneck/update-container-description-action","commit":"cf2977b0f3d189227f140ecbc6402c5a042b34e4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Code-Review","score":0,"reason":"Found 0/2 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-17T15:45:29.448Z","repository_id":65155392,"created_at":"2025-08-17T15:45:29.448Z","updated_at":"2025-08-17T15:45:29.448Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273785568,"owners_count":25167879,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cd","ci","container-registry","containers","docker","dockerhub","github","github-actions","github-workflow","harbor","quay"],"created_at":"2024-08-04T09:00:20.161Z","updated_at":"2025-09-05T16:37:27.329Z","avatar_url":"https://github.com/christian-korneck.png","language":null,"funding_links":[],"categories":["Projects"],"sub_categories":[],"readme":"# Update Container Description\n\nThis github action updates the description of a container repo on [Docker Hub](https://hub.docker.com), [Quay](https://quay.io) or [Harbor](https://goharbor.io) v2 from a README file.\n\nThis is useful when building and pushing Docker images with github actions. It can ensure that the description of a container repo stays in sync with the README file in the github repo.\n\n# Background\n\nThis action uses [`docker-pushrm`](https://github.com/christian-korneck/docker-pushrm) (speak: *Docker Push Readme*), a commandline tool and Docker CLI plugin for updating container repo docs.\n\n# Example for Docker Hub\n\n- create a secret `DOCKER_PASS` in the github repo's settings\n- add to your `.github/workflows/\u003cworkflow\u003e.yml`:\n\n```\nname: Push README to Docker Hub\non: push\njobs:\n  PushContainerReadme:\n    runs-on: ubuntu-latest\n    name: Push README to Docker Hub\n    steps:\n      - name: git checkout\n        uses: actions/checkout@v2\n      - name: push README to Dockerhub\n        uses: christian-korneck/update-container-description-action@v1\n        env:\n          DOCKER_USER: my-user\n          DOCKER_PASS: ${{ secrets.DOCKER_PASS }}\n        with:\n          destination_container_repo: my-user/my-repo\n          provider: dockerhub\n          short_description: 'my short description 😊'\n          readme_file: 'README.md'\n```\n\n# Example for Quay\n\n- create an api key token in the quay.io webinterface ([how to create](https://github.com/christian-korneck/docker-pushrm#log-in-to-quay-registry))\n- create a secret `APIKEY__QUAY_IO` in the github repo's settings\n- add to your `.github/workflows/\u003cworkflow\u003e.yml`:\n\n```\nname: Push README to Quay.io\non: push\njobs:\n  PushContainerReadme:\n    runs-on: ubuntu-latest\n    name: Push README to Quay.io\n    steps:\n      - name: git checkout\n        uses: actions/checkout@v2\n      - name: push README to Quay.io\n        uses: christian-korneck/update-container-description-action@v1\n        env:\n          DOCKER_APIKEY: ${{ secrets.APIKEY__QUAY_IO }}\n        with:\n          destination_container_repo: quay.io/my-user/my-repo\n          provider: quay\n          readme_file: 'README.md'\n```\n\n# Example for Harbor v2\n\n- create a secret `HARBOR_PASS` in the github repo's settings\n- add to your `.github/workflows/\u003cworkflow\u003e.yml`:\n\n```\nname: Push README to demo.goharbor.io\non: push\njobs:\n  PushContainerReadme:\n    runs-on: ubuntu-latest\n    name: Push README to demo.goharbor.io\n    steps:\n      - name: git checkout\n        uses: actions/checkout@v2\n      - name: push README to Dockerhub\n        uses: christian-korneck/update-container-description-action@v1\n        env:\n          DOCKER_USER: my-user\n          DOCKER_PASS: ${{ secrets.HARBOR_PASS }}\n        with:\n          destination_container_repo: demo.goharbor.io/my-project/my-repo\n          provider: harbor2\n          readme_file: 'README.md'\n```\n\n# Reference\n\n## Inputs\n\n### `destination_container_repo`\n\n**Required** the destination container repo    \nExample: `my-user/my-repo` or `myserver.com/my-user/my-repo`.\n\n### `provider`\n\n**Optional** repo provider type.\n\nSupported values:\n- `dockerhub`\n- `quay`\n- `harbor2`\n\nDefaults to `dockerhub` when not set.\n\n### `short_description`\n\n**Optional** Sets or updates the repo's short description (max. 100 characters). Only for provider `dockerhub`.\n\n### `readme_file`\n\n**Optional** Path to the source README file    \nExample: `./my-README.md`\n\nDefaults to `./README.md` when not set.\n\n## Required env vars\n\n### for providers `dockerhub`, `harbor2`:\n\n- `DOCKER_USER` - username\n- `DOCKER_PASS` - password\n\n### for provider `quay`:\n- `DOCKER_APIKEY` - quay.io API key (see [here](https://github.com/christian-korneck/docker-pushrm#log-in-to-quay-registry) for how to create)\n\n\n## Outputs\n\nnone (just succeeds or fails)\n\n----\nAll trademarks belong to their respective owners.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristian-korneck%2Fupdate-container-description-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchristian-korneck%2Fupdate-container-description-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristian-korneck%2Fupdate-container-description-action/lists"}