starred/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-05-30 23:40:40 +02:00
Code Issues 1.0k Packages Projects Releases 10 Wiki Activity

[PR #3461] [MERGED] Add OpenContainers Annotations as Labels to Docker Image #3981

New Issue
Closed
opened 2026-04-25 00:17:49 +02:00 by adam · 0 comments
adam commented 2026-04-25 00:17:49 +02:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/advplyr/audiobookshelf/pull/3461
Author: @mpgirro
Created: 9/26/2024
Status: ✅ Merged
Merged: 9/26/2024
Merged by: @advplyr

Base: master ← Head: oci-image-source

📝 Commits (1)

  • e6c0b69 Add OpenContainer Image Format Annotations as Labels to Docker Image

📊 Changes

1 file changed (+1 additions, -0 deletions)

View changed files

📝 .github/workflows/docker-build.yml (+1 -0)

📄 Description

This PR introduces OpenContainer (OCI) image format annotations as labels to the built Docker images. The labels are already automatically extracted using the Docker Metadata Action in the GitHub Action workflow, ensuring consistent and accurate metadata is applied to the image during the build process. However, this information was not yet passed to the image build process.

Key Benefits

  • Automated Metadata Generation: The Docker Metadata Action automatically extracts relevant information such as the image’s title, description, source, version, revision, and more. This eliminates manual intervention and ensures the labels remain accurate and up-to-date with each build.

  • Enhanced Metadata: All labels from the Docker Metadata Action are added, providing comprehensive details about the image. This includes:

    • org.opencontainers.image.title
    • org.opencontainers.image.description
    • org.opencontainers.image.version
    • org.opencontainers.image.url
    • org.opencontainers.image.source
    • org.opencontainers.image.revision
    • org.opencontainers.image.created
    • org.opencontainers.image.licenses

  • Integration with Dependency Management Tools: Tools like Dependabot and Renovate will be able to recognize these labels and use them when opening PRs for dependency updates. This allows these tools to show detailed information about image changes, making it easier for developers to evaluate the impact of updates.

  • Standardization: By adhering to OCI standards and adding all relevant labels, the Docker image becomes more interoperable with various container registries and tools, improving compatibility and usability across different platforms.

This automated process ensures better visibility into the image lifecycle and simplifies maintenance in CI/CD pipelines, aligning the project with best practices for container image management.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/advplyr/audiobookshelf/pull/3461 **Author:** [@mpgirro](https://github.com/mpgirro) **Created:** 9/26/2024 **Status:** ✅ Merged **Merged:** 9/26/2024 **Merged by:** [@advplyr](https://github.com/advplyr) **Base:** `master` ← **Head:** `oci-image-source` --- ### 📝 Commits (1) - [`e6c0b69`](https://github.com/advplyr/audiobookshelf/commit/e6c0b697aaec07c217dc3a1d4b853b8384eccc58) Add OpenContainer Image Format Annotations as Labels to Docker Image ### 📊 Changes **1 file changed** (+1 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/docker-build.yml` (+1 -0) </details> ### 📄 Description This PR introduces [OpenContainer (OCI)](https://opencontainers.org) image format [annotations](https://specs.opencontainers.org/image-spec/annotations/) as labels to the built Docker images. The labels are already automatically extracted using the [Docker Metadata Action](https://github.com/docker/metadata-action) in the GitHub Action workflow, ensuring consistent and accurate metadata is applied to the image during the build process. However, this information was not yet passed to the image build process. # Key Benefits - __Automated Metadata Generation__: The Docker Metadata Action automatically extracts relevant information such as the image’s title, description, source, version, revision, and more. This eliminates manual intervention and ensures the labels remain accurate and up-to-date with each build. - __Enhanced Metadata__: All labels from the Docker Metadata Action are added, providing comprehensive details about the image. This includes: - `org.opencontainers.image.title` - `org.opencontainers.image.description` - `org.opencontainers.image.version` - `org.opencontainers.image.url` - `org.opencontainers.image.source` - `org.opencontainers.image.revision` - `org.opencontainers.image.created` - `org.opencontainers.image.licenses` - __Integration with Dependency Management Tools__: Tools like [Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide) and [Renovate](https://docs.renovatebot.com) will be able to recognize these labels and use them when opening PRs for dependency updates. This allows these tools to show detailed information about image changes, making it easier for developers to evaluate the impact of updates. - __Standardization__: By adhering to OCI standards and adding all relevant labels, the Docker image becomes more interoperable with various container registries and tools, improving compatibility and usability across different platforms. This automated process ensures better visibility into the image lifecycle and simplifies maintenance in CI/CD pipelines, aligning the project with best practices for container image management. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2026-04-25 00:17:49 +02:00
adam closed this issue 2026-04-25 00:17:49 +02:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
authentication
backlog
bug
chapter editor
config-issue
ebooks
encoding/embedding
enhancement
help wanted
listening sessions & progress
planned
possible plugin
progress sync
pull-request
Mirrored from GitHub Pull Request
 sorting/filtering/searching
unable to reproduce
upload
users & permissions
waiting
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#3981
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?