Merge pull request #154 from chenxiaolong/changelog

Shorten changelog links
chenxiaolong · Sep 20, 2023 · 1f08cb6 · 1f08cb6
2 parents 64c11c2 + ed68f09
commit 1f08cb6
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 47 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 <!--
     When adding new changelog entries, use [Issue #0] to link to issues and
-    [PR #0 @user] to link to pull requests. Then run:
+    [PR #0] to link to pull requests. Then run:
 
         cargo xtask update-changelog
 
@@ -9,52 +9,52 @@
 
 ### Version 2.0.3
 
-* Upgrade xz version in precompiled binaries ([Issue #138], [PR #139 @chenxiaolong])
+* Upgrade xz version in precompiled binaries ([Issue #138], [PR #139])
     * This fixes the `ota extract` and `ota verify` commands in some multithreaded situations.
-* Add `--version` option to print out avbroot's version ([Issue #138], [PR #140 @chenxiaolong])
-* Add support for dm-verify FEC (forward error correction) ([Issue #145], [PR #146 @chenxiaolong])
+* Add `--version` option to print out avbroot's version ([Issue #138], [PR #140])
+* Add support for dm-verify FEC (forward error correction) ([Issue #145], [PR #146])
     * `ota verify` and `avb verify` will now check the FEC data.
-* Print status and warning messages to stderr ([PR #149 @chenxiaolong])
-* Add new `avb unpack`, `avb pack`, and `avb repack` commands for AVB images ([Issue #144], [Issue #148], [PR #152 @chenxiaolong])
+* Print status and warning messages to stderr ([PR #149])
+* Add new `avb unpack`, `avb pack`, and `avb repack` commands for AVB images ([Issue #144], [Issue #148], [PR #152])
     * `avb verify` now optionally accepts `--repair` to fix corrupted dm-verity images.
 
 Behind-the-scenes changes:
 
-* Remove unnecessary use of `Arc` ([PR #147 @chenxiaolong])
-* Use bstr crate to escape mostly UTF-8 binary data ([PR #150 @chenxiaolong])
+* Remove unnecessary use of `Arc` ([PR #147])
+* Use bstr crate to escape mostly UTF-8 binary data ([PR #150])
 
 ### Version 2.0.2
 
-* Fix `data_offset` being set for payload operations that don't need it ([PR #136 @chenxiaolong])
+* Fix `data_offset` being set for payload operations that don't need it ([PR #136])
     * This fixes patched stock OnePlus images from being rejected when flashing.
 
 Behind-the-scenes changes:
 
-* Move full OTA check to CLI functions to allow library functions to parse delta OTAs ([PR #135 @chenxiaolong])
-* Remove unnecessary use of `anyhow` macro ([PR #137 @chenxiaolong])
+* Move full OTA check to CLI functions to allow library functions to parse delta OTAs ([PR #135])
+* Remove unnecessary use of `anyhow` macro ([PR #137])
 
 ### Version 2.0.1
 
-* Add support for Magisk 263xx ([PR #132 @chenxiaolong])
+* Add support for Magisk 263xx ([PR #132])
 
 ### Version 2.0.0
 
-* Initial Rust release. The old Python implementation can be found in the `python` branch. ([PR #130 @chenxiaolong])
+* Initial Rust release. The old Python implementation can be found in the `python` branch. ([PR #130])
 
 <!-- Do not manually edit the lines below. Use `cargo xtask update-changelog` to regenerate. -->
 [Issue #138]: https://github.com/chenxiaolong/avbroot/issues/138
 [Issue #144]: https://github.com/chenxiaolong/avbroot/issues/144
 [Issue #145]: https://github.com/chenxiaolong/avbroot/issues/145
 [Issue #148]: https://github.com/chenxiaolong/avbroot/issues/148
-[PR #130 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/130
-[PR #132 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/132
-[PR #135 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/135
-[PR #136 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/136
-[PR #137 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/137
-[PR #139 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/139
-[PR #140 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/140
-[PR #146 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/146
-[PR #147 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/147
-[PR #149 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/149
-[PR #150 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/150
-[PR #152 @chenxiaolong]: https://github.com/chenxiaolong/avbroot/pull/152
+[PR #130]: https://github.com/chenxiaolong/avbroot/pull/130
+[PR #132]: https://github.com/chenxiaolong/avbroot/pull/132
+[PR #135]: https://github.com/chenxiaolong/avbroot/pull/135
+[PR #136]: https://github.com/chenxiaolong/avbroot/pull/136
+[PR #137]: https://github.com/chenxiaolong/avbroot/pull/137
+[PR #139]: https://github.com/chenxiaolong/avbroot/pull/139
+[PR #140]: https://github.com/chenxiaolong/avbroot/pull/140
+[PR #146]: https://github.com/chenxiaolong/avbroot/pull/146
+[PR #147]: https://github.com/chenxiaolong/avbroot/pull/147
+[PR #149]: https://github.com/chenxiaolong/avbroot/pull/149
+[PR #150]: https://github.com/chenxiaolong/avbroot/pull/150
+[PR #152]: https://github.com/chenxiaolong/avbroot/pull/152
diff --git a/xtask/src/changelog.rs b/xtask/src/changelog.rs
@@ -20,16 +20,11 @@ use crate::WORKSPACE_DIR;
 struct LinkRef {
     link_type: String,
     number: u32,
-    user: Option<String>,
 }
 
 impl fmt::Display for LinkRef {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "[{} #{}", self.link_type, self.number)?;
-        if let Some(u) = &self.user {
-            write!(f, " @{}", u)?;
-        }
-        write!(f, "]")
+        write!(f, "[{} #{}]", self.link_type, self.number)
     }
 }
 
@@ -55,7 +50,7 @@ fn check_brackets(line: &str) -> Result<()> {
 
 fn update_changelog_links(path: &Path, base_url: &str) -> Result<()> {
     let re_standalone_link = Regex::new(r"\[([^\]]+)\]($|[^\(\[])")?;
-    let re_auto_link = Regex::new(r"^(Issue|PR) #([0-9]+)(?: @([a-zA-Z0-9\-]+))?$")?;
+    let re_auto_link = Regex::new(r"^(Issue|PR) #([0-9]+)?$")?;
     let mut links = BTreeMap::<LinkRef, String>::new();
 
     let raw_reader = File::open(path)?;
@@ -85,22 +80,11 @@ fn update_changelog_links(path: &Path, base_url: &str) -> Result<()> {
                 let link_ref = captures.get(0).unwrap().as_str();
                 let link_type = captures.get(1).unwrap().as_str();
                 let number: u32 = captures.get(2).unwrap().as_str().parse()?;
-                let user = captures.get(3).map(|c| c.as_str());
 
                 let link = match link_type {
-                    "Issue" => {
-                        if user.is_some() {
-                            bail!("{link_ref} should not have a username");
-                        }
-                        format!("{base_url}/issues/{number}")
-                    }
-                    "PR" => {
-                        if user.is_none() {
-                            bail!("{link_ref} should have a username");
-                        }
-                        format!("{base_url}/pull/{number}")
-                    }
-                    t => bail!("Unknown link type: {t:?}"),
+                    "Issue" => format!("{base_url}/issues/{number}"),
+                    "PR" => format!("{base_url}/pull/{number}"),
+                    t => bail!("Unknown link type in {link_ref:?}: {t:?}"),
                 };
 
                 // #0 is used for examples only.
@@ -109,7 +93,6 @@ fn update_changelog_links(path: &Path, base_url: &str) -> Result<()> {
                         LinkRef {
                             link_type: link_type.to_owned(),
                             number,
-                            user: user.map(|u| u.to_owned()),
                         },
                         link,
                     );