Release file: support Version field

xzhang1 · xzhang1 · commit e2ebcbb02a12 · 2026-03-03T07:38:44.000Z
https://wiki.debian.org/DebianRepository/Format#Version The Version field, if specified, shall be the version of the release. On the other hand, if not set or set to an empty value, the Version field will not be included in the Release file. Signed-off-by: Zhang Xiao <xiao.zhang@windriver.com>
diff --git a/AUTHORS b/AUTHORS
@@ -81,3 +81,4 @@ List of contributors, in chronological order:
 * Brian Witt (https://github.com/bwitt)
 * Ales Bregar (https://github.com/abregar)
 * Tim Foerster (https://github.com/tonobo)
+* Zhang Xiao (https://github.com/xzhang1)
diff --git a/api/publish.go b/api/publish.go
@@ -186,6 +186,8 @@ type publishedRepoCreateParams struct {
 	SignedBy *string `                            json:"SignedBy"              example:""`
 	// Enable multiple packages with the same filename in different distributions
 	MultiDist *bool `                             json:"MultiDist"             example:"false"`
+	// Version of the release
+	Version string `                              json:"Version"               example:""`
 }
 
 // @Summary Create Published Repository
@@ -361,6 +363,10 @@ func apiPublishRepoOrSnapshot(c *gin.Context) {
 			published.SignedBy = *b.SignedBy
 		}
 
+		if b.Version != "" {
+			published.Version = b.Version
+		}
+
 		duplicate := collection.CheckDuplicate(published)
 		if duplicate != nil {
 			_ = collectionFactory.PublishedRepoCollection().LoadComplete(duplicate, collectionFactory)
@@ -404,6 +410,8 @@ type publishedRepoUpdateSwitchParams struct {
     Label *string `                               json:"Label"          example:"Debian"`
     // Value of Origin: field in published repository stanza
     Origin *string `                              json:"Origin"         example:"Debian"`
+    // Version of the release: Optional
+    Version *string `                             json:"Version"        example:"13.3"`
 }
 
 // @Summary Update Published Repository
@@ -503,6 +511,10 @@ func apiPublishUpdateSwitch(c *gin.Context) {
 		published.Origin = *b.Origin
 	}
 
+	if b.Version != nil {
+		published.Version = *b.Version
+	}
+
 	resources := []string{string(published.Key())}
 	taskName := fmt.Sprintf("Update published %s repository %s/%s", published.SourceKind, published.StoragePrefix(), published.Distribution)
 	maybeRunTaskInBackground(c, taskName, resources, func(out aptly.Progress, _ *task.Detail) (*task.ProcessReturnValue, error) {
@@ -1000,6 +1012,8 @@ type publishedRepoUpdateParams struct {
     Label *string `                               json:"Label"          example:"Debian"`
     // Value of Origin: field in published repository stanza
     Origin *string `                              json:"Origin"         example:"Debian"`
+    // Version of the release: Optional
+    Version *string `                             json:"Version"        example:"13.3"`
 }
 
 // @Summary Update Published Repository
@@ -1080,6 +1094,10 @@ func apiPublishUpdate(c *gin.Context) {
 		published.Origin = *b.Origin
 	}
 
+	if b.Version != nil {
+		published.Version = *b.Version
+	}
+
 	resources := []string{string(published.Key())}
 	taskName := fmt.Sprintf("Update published %s repository %s/%s", published.SourceKind, published.StoragePrefix(), published.Distribution)
 	maybeRunTaskInBackground(c, taskName, resources, func(out aptly.Progress, _ *task.Detail) (*task.ProcessReturnValue, error) {
diff --git a/cmd/publish_repo.go b/cmd/publish_repo.go
@@ -53,6 +53,7 @@ Example:
 	cmd.Flag.Bool("acquire-by-hash", false, "provide index files by hash")
 	cmd.Flag.String("signed-by", "", "an optional field containing a comma separated list of OpenPGP key fingerprints to be used for validating the next Release file")
 	cmd.Flag.Bool("multi-dist", false, "enable multiple packages with the same filename in different distributions")
+	cmd.Flag.String("version", "", "version of the release")
 
 	return cmd
 }
diff --git a/cmd/publish_snapshot.go b/cmd/publish_snapshot.go
@@ -158,6 +158,10 @@ func aptlyPublishSnapshotOrRepo(cmd *commander.Command, args []string) error {
 		published.MultiDist = context.Flags().Lookup("multi-dist").Value.Get().(bool)
 	}
 
+	if context.Flags().IsSet("version") {
+		published.Version = context.Flags().Lookup("version").Value.String()
+	}
+
 	duplicate := collectionFactory.PublishedRepoCollection().CheckDuplicate(published)
 	if duplicate != nil {
 		_ = collectionFactory.PublishedRepoCollection().LoadComplete(duplicate, collectionFactory)
@@ -252,6 +256,7 @@ Example:
 	cmd.Flag.Bool("force-overwrite", false, "overwrite files in package pool in case of mismatch")
 	cmd.Flag.Bool("acquire-by-hash", false, "provide index files by hash")
 	cmd.Flag.String("signed-by", "", "an optional field containing a comma separated list of OpenPGP key fingerprints to be used for validating the next Release file")
+	cmd.Flag.String("version", "", "version of the release")
 	cmd.Flag.Bool("multi-dist", false, "enable multiple packages with the same filename in different distributions")
 
 	return cmd
diff --git a/cmd/publish_switch.go b/cmd/publish_switch.go
@@ -103,6 +103,10 @@ func aptlyPublishSwitch(cmd *commander.Command, args []string) error {
 		published.SignedBy = context.Flags().Lookup("signed-by").Value.String()
 	}
 
+	if context.Flags().IsSet("version") {
+		published.Version = context.Flags().Lookup("version").Value.String()
+	}
+
 	if context.Flags().IsSet("multi-dist") {
 		published.MultiDist = context.Flags().Lookup("multi-dist").Value.Get().(bool)
 	}
@@ -167,6 +171,7 @@ This command would switch published repository (with one component) named ppa/wh
 	cmd.Flag.String("component", "", "component names to update (for multi-component publishing, separate components with commas)")
 	cmd.Flag.Bool("force-overwrite", false, "overwrite files in package pool in case of mismatch")
 	cmd.Flag.String("signed-by", "", "an optional field containing a comma separated list of OpenPGP key fingerprints to be used for validating the next Release file")
+	cmd.Flag.String("version", "", "version of the release")
 	cmd.Flag.Bool("skip-cleanup", false, "don't remove unreferenced files in prefix/component")
 	cmd.Flag.Bool("multi-dist", false, "enable multiple packages with the same filename in different distributions")
 
diff --git a/cmd/publish_update.go b/cmd/publish_update.go
@@ -76,6 +76,10 @@ func aptlyPublishUpdate(cmd *commander.Command, args []string) error {
 		published.MultiDist = context.Flags().Lookup("multi-dist").Value.Get().(bool)
 	}
 
+	if context.Flags().IsSet("version") {
+		published.Version = context.Flags().Lookup("version").Value.String()
+	}
+
 	err = published.Publish(context.PackagePool(), context, collectionFactory, signer, context.Progress(), forceOverwrite, context.SkelPath())
 	if err != nil {
 		return fmt.Errorf("unable to publish: %s", err)
@@ -142,6 +146,7 @@ Example:
 	cmd.Flag.Bool("multi-dist", false, "enable multiple packages with the same filename in different distributions")
     cmd.Flag.String("origin", "", "overwrite origin name to publish")
     cmd.Flag.String("label", "", "overwrite label to publish")
+    cmd.Flag.String("version", "", "version of the release")
 
 	return cmd
 }
diff --git a/deb/publish.go b/deb/publish.go
@@ -55,6 +55,7 @@ type PublishedRepo struct {
 	Label                string
 	Suite                string
 	Codename             string
+	Version              string
 	// Architectures is a list of all architectures published
 	Architectures []string
 	// SourceKind is "local"/"repo"
@@ -526,6 +527,7 @@ func (p *PublishedRepo) MarshalJSON() ([]byte, error) {
 		"Origin":               p.Origin,
 		"Suite":                p.Suite,
 		"Codename":             p.Codename,
+		"Version":              p.Version,
 		"NotAutomatic":         p.NotAutomatic,
 		"ButAutomaticUpgrades": p.ButAutomaticUpgrades,
 		"Prefix":               p.Prefix,
@@ -1080,6 +1082,9 @@ func (p *PublishedRepo) Publish(packagePool aptly.PackagePool, publishedStorageP
 				if p.SignedBy != "" {
 					release["Signed-By"] = p.SignedBy
 				}
+				if p.Version != "" {
+					release["Version"] = p.Version
+				}
 
 				var bufWriter *bufio.Writer
 				bufWriter, err = indexes.ReleaseIndex(component, arch, udeb).BufWriter()
@@ -1158,6 +1163,9 @@ func (p *PublishedRepo) Publish(packagePool aptly.PackagePool, publishedStorageP
 		// Let's use a century as a "forever" value.
 		release["Valid-Until"] = publishDate.AddDate(100, 0, 0).Format(datetime_format)
 	}
+	if p.Version != "" {
+        release["Version"] = p.Version
+    }
 	release["Description"] = " Generated by aptly\n"
 	release["MD5Sum"] = ""
 	release["SHA1"] = ""
diff --git a/man/aptly.1 b/man/aptly.1
@@ -1569,6 +1569,10 @@ Options:
 set value for Signed-By field
 .
 .TP
+\-\fBversion\fR
+version of the release
+.
+.TP
 \-\fBacquire\-by\-hash\fR
 provide index files by hash
 .
@@ -1714,6 +1718,10 @@ Options:
 set value for Signed-By field
 .
 .TP
+\-\fBversion\fR
+version of the release
+.
+.TP
 \-\fBacquire\-by\-hash\fR
 provide index files by hash
 .
@@ -2187,6 +2195,10 @@ Options:
 set value for Signed-By field
 .
 .TP
+\-\fBversion\fR
+version of the release
+.
+.TP
 \-\fBbatch\fR
 run GPG with detached tty
 .
diff --git a/system/t06_publish/PublishList5Test_gold b/system/t06_publish/PublishList5Test_gold
@@ -24,7 +24,8 @@
       }
     ],
     "Storage": "",
-    "Suite": ""
+    "Suite": "",
+    "Version": ""
   },
   {
     "AcquireByHash": false,
@@ -50,7 +51,8 @@
       }
     ],
     "Storage": "",
-    "Suite": ""
+    "Suite": "",
+    "Version": ""
   },
   {
     "AcquireByHash": false,
@@ -77,7 +79,8 @@
       }
     ],
     "Storage": "",
-    "Suite": ""
+    "Suite": "",
+    "Version": ""
   },
   {
     "AcquireByHash": false,
@@ -104,6 +107,7 @@
       }
     ],
     "Storage": "",
-    "Suite": ""
+    "Suite": "",
+    "Version": ""
   }
 ]
diff --git a/system/t06_publish/PublishRepo37Test_gold b/system/t06_publish/PublishRepo37Test_gold
@@ -0,0 +1,14 @@
+Loading packages...
+Generating metadata files and linking package files...
+Finalizing metadata files...
+Signing file 'Release' with gpg, please enter your passphrase when prompted:
+Clearsigning file 'Release' with gpg, please enter your passphrase when prompted:
+
+Local repo local-repo has been successfully published.
+Please setup your webserver to serve directory '${HOME}/.aptly/public' with autoindexing.
+Now you can add following line to apt sources:
+  deb http://your-server/ maverick contrib
+  deb-src http://your-server/ maverick contrib
+Don't forget to add your GPG key to apt with apt-key.
+
+You can also use `aptly serve` to publish your repositories over HTTP quickly.
diff --git a/system/t06_publish/PublishRepo37Test_release b/system/t06_publish/PublishRepo37Test_release
@@ -0,0 +1,12 @@
+Origin: . maverick
+Label: label37
+Suite: maverick
+Version: 13.3
+Codename: maverick
+Architectures: i386
+Components: contrib
+Description: Generated by aptly
+MD5Sum:
+SHA1:
+SHA256:
+SHA512:
diff --git a/system/t06_publish/PublishShow3Test_gold b/system/t06_publish/PublishShow3Test_gold
@@ -23,5 +23,6 @@
     }
   ],
   "Storage": "",
-  "Suite": ""
+  "Suite": "",
+  "Version": ""
 }
diff --git a/system/t06_publish/PublishShow4Test_gold b/system/t06_publish/PublishShow4Test_gold
@@ -23,5 +23,6 @@
     }
   ],
   "Storage": "",
-  "Suite": ""
+  "Suite": "",
+  "Version": ""
 }
diff --git a/system/t06_publish/PublishSnapshot24Test_release b/system/t06_publish/PublishSnapshot24Test_release
@@ -1,6 +1,7 @@
 Origin: aptly24
 Label: . squeeze
 Suite: squeeze
+Version: 13.3
 Codename: squeeze
 NotAutomatic: yes
 ButAutomaticUpgrades: yes
diff --git a/system/t06_publish/PublishSwitch17Test_release b/system/t06_publish/PublishSwitch17Test_release
@@ -1,6 +1,7 @@
 Origin: LP-PPA-gladky-anton-gnuplot
 Label: . maverick
 Suite: maverick
+Version: 13.3
 Codename: maverick
 Signed-By: a,string
 Architectures: amd64 i386
diff --git a/system/t06_publish/PublishUpdate20Test_release b/system/t06_publish/PublishUpdate20Test_release
@@ -1,6 +1,7 @@
 Origin: earth
 Label: fun
 Suite: maverick
+Version: 13.3
 Codename: maverick
 Architectures: i386
 Components: main
diff --git a/system/t06_publish/PublishUpdate21Test_gold b/system/t06_publish/PublishUpdate21Test_gold
@@ -0,0 +1,9 @@
+Loading packages...
+Generating metadata files and linking package files...
+Finalizing metadata files...
+Signing file 'Release' with gpg, please enter your passphrase when prompted:
+Clearsigning file 'Release' with gpg, please enter your passphrase when prompted:
+Cleaning up published repository ./maverick...
+Cleaning up component 'main'...
+
+Published local repository ./maverick [i386, source] publishes {main: [local-repo]} has been updated successfully.
diff --git a/system/t06_publish/PublishUpdate21Test_release b/system/t06_publish/PublishUpdate21Test_release
@@ -0,0 +1,11 @@
+Origin: . maverick
+Label: . maverick
+Suite: maverick
+Codename: maverick
+Architectures: i386
+Components: main
+Description: Generated by aptly
+MD5Sum:
+SHA1:
+SHA256:
+SHA512:
diff --git a/system/t06_publish/repo.py b/system/t06_publish/repo.py
@@ -1005,3 +1005,22 @@ def check(self):
         # verify byte-identical output
         second_release = self.read_file('public/dists/maverick/Release')
         self.check_equal(first_release, second_release)
+
+
+class PublishRepo37Test(BaseTest):
+    """
+    publish repo: custom version
+    """
+    fixtureCmds = [
+        "aptly repo create local-repo",
+        "aptly repo add local-repo ${files}",
+    ]
+    runCmd = "aptly publish repo -keyring=${files}/aptly.pub -secret-keyring=${files}/aptly.sec -distribution=maverick -component=contrib -label=label37 -version=13.3 local-repo"
+    gold_processor = BaseTest.expand_environ
+
+    def check(self):
+        super(PublishRepo37Test, self).check()
+
+        # verify contents except of sums
+        self.check_file_contents(
+            'public/dists/maverick/Release', 'release', match_prepare=strip_processor)
diff --git a/system/t06_publish/snapshot.py b/system/t06_publish/snapshot.py
@@ -690,15 +690,15 @@ class PublishSnapshot23Test(BaseTest):
 
 class PublishSnapshot24Test(BaseTest):
     """
-    publish snapshot: custom origin, notautomatic and butautomaticupgrades
+    publish snapshot: custom origin, version, notautomatic and butautomaticupgrades
     """
     fixtureDB = True
     fixturePool = True
     fixtureCmds = [
         "aptly snapshot create snap24 from mirror gnuplot-maverick",
     ]
     sortOutput = True
-    runCmd = "aptly publish snapshot -keyring=${files}/aptly.pub -secret-keyring=${files}/aptly.sec -distribution=squeeze -origin=aptly24 -notautomatic=yes -butautomaticupgrades=yes snap24"
+    runCmd = "aptly publish snapshot -keyring=${files}/aptly.pub -secret-keyring=${files}/aptly.sec -distribution=squeeze -origin=aptly24 -version=13.3 -notautomatic=yes -butautomaticupgrades=yes snap24"
     gold_processor = BaseTest.expand_environ
 
     def check(self):
diff --git a/system/t06_publish/switch.py b/system/t06_publish/switch.py
@@ -607,7 +607,7 @@ def check(self):
 
 class PublishSwitch17Test(BaseTest):
     """
-    publish switch: signed-by
+    publish switch: signed-by, version
     """
     fixtureDB = True
     fixturePool = True
@@ -616,7 +616,7 @@ class PublishSwitch17Test(BaseTest):
         "aptly snapshot create snap2 from mirror gnuplot-maverick",
         "aptly publish snapshot -keyring=${files}/aptly.pub -secret-keyring=${files}/aptly.sec -distribution=maverick snap1",
     ]
-    runCmd = "aptly publish switch -keyring=${files}/aptly.pub -secret-keyring=${files}/aptly.sec -signed-by=a,string maverick snap2"
+    runCmd = "aptly publish switch -keyring=${files}/aptly.pub -secret-keyring=${files}/aptly.sec -signed-by=a,string  -version=13.3 maverick snap2"
     gold_processor = BaseTest.expand_environ
 
     def check(self):
diff --git a/system/t06_publish/update.py b/system/t06_publish/update.py
diff --git a/system/t12_api/publish.py b/system/t12_api/publish.py

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ Example:`
`53`	`53`	`cmd.Flag.Bool("acquire-by-hash", false, "provide index files by hash")`
`54`	`54`	`cmd.Flag.String("signed-by", "", "an optional field containing a comma separated list of OpenPGP key fingerprints to be used for validating the next Release file")`
`55`	`55`	`cmd.Flag.Bool("multi-dist", false, "enable multiple packages with the same filename in different distributions")`
	`56`	`+ cmd.Flag.String("version", "", "version of the release")`
`56`	`57`
`57`	`58`	`return cmd`
`58`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1569,6 +1569,10 @@ Options:`
`1569`	`1569`	`set value for Signed-By field`
`1570`	`1570`	`.`
`1571`	`1571`	`.TP`
	`1572`	`+\-\fBversion\fR`
	`1573`	`+version of the release`
	`1574`	`+.`
	`1575`	`+.TP`
`1572`	`1576`	`\-\fBacquire\-by\-hash\fR`
`1573`	`1577`	`provide index files by hash`
`1574`	`1578`	`.`
`@@ -1714,6 +1718,10 @@ Options:`
`1714`	`1718`	`set value for Signed-By field`
`1715`	`1719`	`.`
`1716`	`1720`	`.TP`
	`1721`	`+\-\fBversion\fR`
	`1722`	`+version of the release`
	`1723`	`+.`
	`1724`	`+.TP`
`1717`	`1725`	`\-\fBacquire\-by\-hash\fR`
`1718`	`1726`	`provide index files by hash`
`1719`	`1727`	`.`
`@@ -2187,6 +2195,10 @@ Options:`
`2187`	`2195`	`set value for Signed-By field`
`2188`	`2196`	`.`
`2189`	`2197`	`.TP`
	`2198`	`+\-\fBversion\fR`
	`2199`	`+version of the release`
	`2200`	`+.`
	`2201`	`+.TP`
`2190`	`2202`	`\-\fBbatch\fR`
`2191`	`2203`	`run GPG with detached tty`
`2192`	`2204`	`.`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,8 @@`
`24`	`24`	`}`
`25`	`25`	`],`
`26`	`26`	`"Storage": "",`
`27`		`- "Suite": ""`
	`27`	`+ "Suite": "",`
	`28`	`+ "Version": ""`
`28`	`29`	`},`
`29`	`30`	`{`
`30`	`31`	`"AcquireByHash": false,`
`@@ -50,7 +51,8 @@`
`50`	`51`	`}`
`51`	`52`	`],`
`52`	`53`	`"Storage": "",`
`53`		`- "Suite": ""`
	`54`	`+ "Suite": "",`
	`55`	`+ "Version": ""`
`54`	`56`	`},`
`55`	`57`	`{`
`56`	`58`	`"AcquireByHash": false,`
`@@ -77,7 +79,8 @@`
`77`	`79`	`}`
`78`	`80`	`],`
`79`	`81`	`"Storage": "",`
`80`		`- "Suite": ""`
	`82`	`+ "Suite": "",`
	`83`	`+ "Version": ""`
`81`	`84`	`},`
`82`	`85`	`{`
`83`	`86`	`"AcquireByHash": false,`
`@@ -104,6 +107,7 @@`
`104`	`107`	`}`
`105`	`108`	`],`
`106`	`109`	`"Storage": "",`
`107`		`- "Suite": ""`
	`110`	`+ "Suite": "",`
	`111`	`+ "Version": ""`
`108`	`112`	`}`
`109`	`113`	`]`