.github/workflows/release.yml

@@ -32,7 +32,7 @@ jobs:
           go-version: '>=1.23.0'
           cache: false
       - name: Build release
-        uses: goreleaser/goreleaser-action@5742e2a039330cbb23ebf35f046f814d4c6ff811 # v5.1.0
+        uses: goreleaser/goreleaser-action@90a3faa9d0182683851fbfa97ca1a2cb983bfca3 # v6.2.1
         with:
           distribution: goreleaser
           version: latest
@@ -55,7 +55,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@6524bf65af31da8d45b59e8c27de4bd072b392f5 # v3.8.0
       - name: Build and push Docker image
-        run: docker buildx build --platform=linux/amd64,linux/arm64,linux/arm/v7 . --file Dockerfile --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}"
+        run: docker buildx build --platform=linux/amd64,linux/arm64,linux/arm/v7 . --file Dockerfile --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}" --build-arg NO_SNAPSHOT=true
       - name: Log in to registry
         run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
       - name: Push image
@@ -73,4 +73,5 @@ jobs:
           echo VERSION=$VERSION
           docker buildx build --push \
             --tag $IMAGE_ID:$VERSION \
+            --build-arg NO_SNAPSHOT=true \
             --platform linux/amd64,linux/arm64,linux/arm/v7 .

.goreleaser.yaml

@@ -1,8 +1,11 @@
 # Make sure to check the documentation at https://goreleaser.com
+version: 2
 before:
   hooks:
     - go mod tidy
     - go generate ./...
+gomod:
+  proxy: true
 builds:
   - main: ./cmd/rwp/
     env:
@@ -13,21 +16,20 @@ builds:
       - linux
       - windows
       - darwin
+    goarch:
+      - '386'
+      - amd64
+      - arm
+      - arm64
+    goarm:
+      - '7'
     goamd64:
       - v3
-
-#  - main: ./cmd/server/
-#    env:
-#      - CGO_ENABLED=0
-#    id: rwp-server
-#    binary: rwp-server
-#    goos:
-#      - linux
-#      - windows
-#      - darwin
+    ldflags:
+      - -s -w
 
 archives:
-  - format: tar.gz
+  - formats: tar.gz
     # this name template makes the OS and Arch compatible with the results of uname.
     # Used to start with {{ .ProjectName }}
     name_template: >-
@@ -40,8 +42,8 @@ archives:
     # use zip for windows archives
     format_overrides:
     - goos: windows
-      format: zip
+      formats: ['zip']
 checksum:
   name_template: 'checksums.txt'
 snapshot:
-  name_template: "{{ incpatch .Version }}-next"
+  version_template: "{{ incpatch .Version }}-next"

CHANGELOG.md

@@ -6,7 +6,33 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
-None
+## [0.8.1] - 2025-02-24
+
+### Changed
+
+- Docker containers & releases now properly build ARM (32-bit) images with v7 (not v6) support
+
+## [0.8.0] - 2025-02-24
+
+### Added
+
+- Support for [EPUB Accessibility 1.1](https://www.w3.org/TR/epub-a11y-11/) conformance values
+- `--version` flag for `rwp`
+- Output of `go-toolkit` version in WebPub metadata. [Based on the Go module pseudo-version](https://github.com/readium/go-toolkit/issues/80#issuecomment-2673888192)
+
+### Changed
+
+- A11y `conformsTo` values are now sorted from highest to lowest conformance level
+
+## [0.7.1] - 2025-02-07
+
+### Added
+
+- Add [TDMRep](https://www.w3.org/community/reports/tdmrep/CG-FINAL-tdmrep-20240510/#sec-epub3) support for EPUB 2 & 3.
+
+### Fixed
+
+- Fix typo in EAA exemption.
 
 ## [0.7.0] - 2025-01-31
 

Dockerfile

@@ -1,9 +1,10 @@
 FROM --platform=$BUILDPLATFORM golang:1-bookworm@sha256:3149bc5043fa58cf127fd8db1fdd4e533b6aed5a40d663d4f4ae43d20386665f AS builder
 ARG BUILDARCH TARGETOS TARGETARCH
+ARG NO_SNAPSHOT=false
 
 # Install GoReleaser
-RUN wget --no-verbose "https://github.com/goreleaser/goreleaser/releases/download/v1.26.2/goreleaser_1.26.2_$BUILDARCH.deb"
-RUN dpkg -i "goreleaser_1.26.2_$BUILDARCH.deb"
+RUN wget --no-verbose "https://github.com/goreleaser/goreleaser/releases/download/v2.7.0/goreleaser_2.7.0_$BUILDARCH.deb"
+RUN dpkg -i "goreleaser_2.7.0_$BUILDARCH.deb"
 
 # Create and change to the app directory.
 WORKDIR /app
@@ -17,12 +18,15 @@ RUN go mod download
 # Copy local code to the container image.
 COPY . ./
 
+RUN git describe --tags --always
+
 # RUN git lfs pull && ls -alh publications
 
 # Run goreleaser
 RUN --mount=type=cache,target=/root/.cache/go-build \
     --mount=type=cache,target=/go/pkg \
-    GOOS=$TARGETOS GOARCH=$TARGETARCH goreleaser build --single-target --id rwp --skip=validate --snapshot --output ./rwp
+    GOOS=$TARGETOS GOARCH=$TARGETARCH GOAMD64=v3 GOARM=7 \
+    goreleaser build --single-target --id rwp --skip=validate $(case "$NO_SNAPSHOT" in yes|true|1) ;; *) echo "--snapshot";; esac) --output ./rwp
 
 # Run tests
 # FROM builder AS tester

cmd/rwp/cmd/root.go

@@ -3,13 +3,15 @@ package cmd
 import (
 	"os"
 
+	"github.com/readium/go-toolkit/pkg/util/version"
 	"github.com/spf13/cobra"
 )
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
-	Use:   "rwp",
-	Short: "Utilities for Readium Web Publications",
+	Use:     "rwp",
+	Short:   "Utilities for Readium Web Publications",
+	Version: version.Version,
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.

pkg/manifest/a11y.go

@@ -2,6 +2,7 @@ package manifest
 
 import (
 	"encoding/json"
+	"slices"
 
 	"github.com/pkg/errors"
 	"github.com/readium/go-toolkit/pkg/internal/extensions"
@@ -12,7 +13,7 @@ import (
 // https://www.w3.org/2021/a11y-discov-vocab/latest/
 // https://readium.org/webpub-manifest/schema/a11y.schema.json
 type A11y struct {
-	ConformsTo            []A11yProfile             `json:"conformsTo,omitempty"`           // An established standard to which the described resource conforms.
+	ConformsTo            A11yProfileList           `json:"conformsTo,omitempty"`           // An established standard to which the described resource conforms.
 	Certification         *A11yCertification        `json:"certification,omitempty"`        // Certification of accessible publications.
 	Summary               string                    `json:"summary,omitempty"`              // A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
 	AccessModes           []A11yAccessMode          `json:"accessMode,omitempty"`           // The human sensory perceptual system or cognitive faculty through which a person may process or perceive information.
@@ -25,7 +26,7 @@ type A11y struct {
 // NewA11y creates a new empty A11y.
 func NewA11y() A11y {
 	return A11y{
-		ConformsTo:            []A11yProfile{},
+		ConformsTo:            A11yProfileList{},
 		AccessModes:           []A11yAccessMode{},
 		AccessModesSufficient: [][]A11yPrimaryAccessMode{},
 		Features:              []A11yFeature{},
@@ -47,6 +48,7 @@ func (a *A11y) Merge(other *A11y) {
 	}
 
 	a.ConformsTo = extensions.AppendIfMissing(a.ConformsTo, other.ConformsTo...)
+	a.ConformsTo.Sort()
 
 	if other.Certification != nil {
 		a.Certification = other.Certification
@@ -86,6 +88,7 @@ func A11yFromJSON(rawJSON map[string]interface{}) (*A11y, error) {
 		return nil, errors.Wrap(err, "failed unmarshalling 'conformsTo'")
 	}
 	a.ConformsTo = A11yProfilesFromStrings(conformsTo)
+	a.ConformsTo.Sort()
 
 	if certJSON, ok := rawJSON["certification"].(map[string]interface{}); ok {
 		c := A11yCertification{
@@ -171,14 +174,70 @@ const (
 	EPUBA11y10WCAG20AA A11yProfile = "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa"
 	// EPUB Accessibility 1.0 - WCAG 2.0 Level AAA
 	EPUBA11y10WCAG20AAA A11yProfile = "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa"
+	// EPUB Accessibility 1.1 - WCAG 2.0 Level A
+	EPUBA11y11WCAG20A A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.0-a"
+	// EPUB Accessibility 1.1 - WCAG 2.0 Level AA
+	EPUBA11y11WCAG20AA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.0-aa"
+	// EPUB Accessibility 1.1 - WCAG 2.0 Level AAA
+	EPUBA11y11WCAG20AAA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.0-aaa"
+	// EPUB Accessibility 1.1 - WCAG 2.1 Level A
+	EPUBA11y11WCAG21A A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.1-a"
+	// EPUB Accessibility 1.1 - WCAG 2.1 Level AA
+	EPUBA11y11WCAG21AA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.1-aa"
+	// EPUB Accessibility 1.1 - WCAG 2.1 Level AAA
+	EPUBA11y11WCAG21AAA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.1-aaa"
+	// EPUB Accessibility 1.1 - WCAG 2.2 Level A
+	EPUBA11y11WCAG22A A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.2-a"
+	// EPUB Accessibility 1.1 - WCAG 2.2 Level AA
+	EPUBA11y11WCAG22AA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.2-aa"
+	// EPUB Accessibility 1.1 - WCAG 2.2 Level AAA
+	EPUBA11y11WCAG22AAA A11yProfile = "https://www.w3.org/TR/epub-a11y-11#wcag-2.2-aaa"
 )
 
+// Used for sorting. Make sure to keep it up-to-date with the consts
+var a11yProfileRanking = map[A11yProfile]int{
+	EPUBA11y10WCAG20A:   1,
+	EPUBA11y10WCAG20AA:  2,
+	EPUBA11y10WCAG20AAA: 3,
+	EPUBA11y11WCAG20A:   4,
+	EPUBA11y11WCAG20AA:  5,
+	EPUBA11y11WCAG20AAA: 6,
+	EPUBA11y11WCAG21A:   7,
+	EPUBA11y11WCAG21AA:  8,
+	EPUBA11y11WCAG21AAA: 9,
+	EPUBA11y11WCAG22A:   10,
+	EPUBA11y11WCAG22AA:  11,
+	EPUBA11y11WCAG22AAA: 12,
+}
+
 func A11yProfilesFromStrings(strings []string) []A11yProfile {
 	return fromStrings(strings, func(str string) A11yProfile {
 		return A11yProfile(str)
 	})
 }
 
+func (p A11yProfile) Compare(other A11yProfile) int {
+	// Compare based on the compatibility level
+	if p == other {
+		return 0
+	}
+
+	pRank := a11yProfileRanking[p]
+	oRank := a11yProfileRanking[other]
+	return oRank - pRank
+}
+
+type A11yProfileList []A11yProfile
+
+func (l A11yProfileList) Sort() {
+	if len(l) <= 1 {
+		return
+	}
+	slices.SortFunc(l, func(a, b A11yProfile) int {
+		return a.Compare(b)
+	})
+}
+
 // A11yCertification represents a certification for an accessible publication.
 type A11yCertification struct {
 	CertifiedBy string `json:"certifiedBy,omitempty"` // Identifies a party responsible for the testing and certification of the accessibility of a Publication.

pkg/manifest/a11y_test.go

@@ -87,6 +87,24 @@ func TestA11yUnmarshalConformsToArray(t *testing.T) {
 	assert.Equal(t, e, m, "unmarshalled JSON object should be equal to A11y object")
 }
 
+func TestA11ySortConformsTo(t *testing.T) {
+	a := A11yProfileList{
+		EPUBA11y10WCAG20A,
+		EPUBA11y11WCAG22A,
+		EPUBA11y11WCAG20AA,
+		EPUBA11y11WCAG21AA,
+		EPUBA11y11WCAG22AAA,
+	}
+	a.Sort()
+	assert.Equal(t, A11yProfileList{
+		EPUBA11y11WCAG22AAA,
+		EPUBA11y11WCAG22A,
+		EPUBA11y11WCAG21AA,
+		EPUBA11y11WCAG20AA,
+		EPUBA11y10WCAG20A,
+	}, a)
+}
+
 func TestA11yUnmarshalAccessModeSufficientContainingBothStringsAndArrays(t *testing.T) {
 	var m A11y
 	assert.NoError(t, json.Unmarshal([]byte(`{"accessModeSufficient": ["auditory", ["visual", "tactile"], [], "visual"]}`), &m))

pkg/manifest/metadata.go

@@ -8,6 +8,7 @@ import (
 	"github.com/go-viper/mapstructure/v2"
 	"github.com/pkg/errors"
 	"github.com/readium/go-toolkit/pkg/internal/util"
+	"github.com/readium/go-toolkit/pkg/util/version"
 )
 
 // TODO replace with generic
@@ -452,6 +453,9 @@ func (m *Metadata) UnmarshalJSON(b []byte) error {
 	return nil
 }
 
+// If you really don't want the version info in your manifest, you can blank this value.
+var ToolkitVersionKey = "https://github.com/readium/go-toolkit/releases"
+
 func (m Metadata) MarshalJSON() ([]byte, error) {
 	j := make(map[string]interface{})
 	if m.OtherMetadata != nil {
@@ -460,6 +464,10 @@ func (m Metadata) MarshalJSON() ([]byte, error) {
 		}
 	}
 
+	if ToolkitVersionKey != "" {
+		j[ToolkitVersionKey] = version.Version
+	}
+
 	if m.Presentation != nil {
 		j["presentation"] = m.Presentation
 	}

pkg/manifest/metadata_test.go

@@ -8,6 +8,10 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func init() {
+	ToolkitVersionKey = "" // Prevent injection of version during testing
+}
+
 func TestMetadataUnmarshalMinimalJSON(t *testing.T) {
 	var m Metadata
 	assert.NoError(t, json.Unmarshal([]byte(`{"title": "Title"}`), &m))

pkg/parser/epub/metadata.go

@@ -675,7 +675,7 @@ func (m PubMetadataAdapter) TDM() *manifest.TDM {
 }
 
 func (m PubMetadataAdapter) a11yConformsTo() []manifest.A11yProfile {
-	profiles := []manifest.A11yProfile{}
+	profiles := manifest.A11yProfileList{}
 
 	if items, ok := m.items[VocabularyDCTerms+"conformsto"]; ok {
 		for _, item := range items {
@@ -691,32 +691,41 @@ func (m PubMetadataAdapter) a11yConformsTo() []manifest.A11yProfile {
 		}
 	}
 
+	profiles.Sort()
 	return profiles
 }
 
 func a11yProfile(value string) manifest.A11yProfile {
 	switch value {
-	case "EPUB Accessibility 1.1 - WCAG 2.0 Level A",
-		"http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-a",
+	case "http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-a",
 		"http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a",
 		"https://idpf.org/epub/a11y/accessibility-20170105.html#wcag-a",
 		"https://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a":
 		return manifest.EPUBA11y10WCAG20A
 
-	case "EPUB Accessibility 1.1 - WCAG 2.0 Level AA",
-		"http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa",
+	case "http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa",
 		"http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa",
 		"https://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa",
 		"https://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa":
 		return manifest.EPUBA11y10WCAG20AA
 
-	case "EPUB Accessibility 1.1 - WCAG 2.0 Level AAA",
-		"http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa",
+	case "http://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa",
 		"http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa",
 		"https://idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa",
 		"https://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa":
 		return manifest.EPUBA11y10WCAG20AAA
-
+	case "EPUB Accessibility 1.1 - WCAG 2.0 Level A":
+		return manifest.EPUBA11y11WCAG20A
+	case "EPUB Accessibility 1.1 - WCAG 2.0 Level AA":
+		return manifest.EPUBA11y11WCAG20AA
+	case "EPUB Accessibility 1.1 - WCAG 2.0 Level AAA":
+		return manifest.EPUBA11y11WCAG20AAA
+	case "EPUB Accessibility 1.1 - WCAG 2.1 Level A":
+		return manifest.EPUBA11y11WCAG21A
+	case "EPUB Accessibility 1.1 - WCAG 2.1 Level AA":
+		return manifest.EPUBA11y11WCAG21AA
+	case "EPUB Accessibility 1.1 - WCAG 2.1 Level AAA":
+		return manifest.EPUBA11y11WCAG21AAA
 	default:
 		return ""
 	}