docs: Fix Related Packages and release workflow for compliance

coenttb · coenttb · commit 8c25e5a935ae · 2025-10-30T16:34:45.000+01:00
- Update Related Packages to use exact GitHub repo descriptions
- Fix release.yml to use correct package name (swift-domain-type)
- Fix target name in documentation generation (Domain not EmailAddress)
- Fix documentation URLs and redirects
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -72,7 +72,7 @@ jobs:
 
           # Create archives of the built libraries
           cd .build
-          tar -czf swift-emailaddress-type-macos.tar.gz \
+          tar -czf swift-domain-type-macos.tar.gz \
             arm64-apple-macosx/release/*.swiftmodule \
             x86_64-apple-macosx/release/*.swiftmodule \
             2>/dev/null || true
@@ -84,22 +84,22 @@ jobs:
           swift package \
             --allow-writing-to-directory ./docs \
             generate-documentation \
-            --target EmailAddress \
+            --target Domain \
             --output-path ./docs \
             --transform-for-static-hosting \
-            --hosting-base-path swift-emailaddress-type
+            --hosting-base-path swift-domain-type
 
           cat > ./docs/index.html << 'EOF'
           <!DOCTYPE html>
           <html>
             <head>
               <meta charset="utf-8">
-              <title>Redirecting to swift-emailaddress-type documentation</title>
-              <meta http-equiv="refresh" content="0; url=./documentation/emailaddress/">
-              <link rel="canonical" href="./documentation/emailaddress/">
+              <title>Redirecting to swift-domain-type documentation</title>
+              <meta http-equiv="refresh" content="0; url=./documentation/domain/">
+              <link rel="canonical" href="./documentation/domain/">
             </head>
             <body>
-              <p>Redirecting to <a href="./documentation/emailaddress/">swift-emailaddress-type documentation</a>...</p>
+              <p>Redirecting to <a href="./documentation/domain/">swift-domain-type documentation</a>...</p>
             </body>
           </html>
           EOF
@@ -113,7 +113,7 @@ jobs:
         uses: softprops/action-gh-release@v2
         with:
           files: |
-            .build/swift-emailaddress-type-macos.tar.gz
+            .build/swift-domain-type-macos.tar.gz
             documentation.zip
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -142,23 +142,23 @@ jobs:
           swift package \
             --allow-writing-to-directory ./docs \
             generate-documentation \
-            --target EmailAddress \
+            --target Domain \
             --output-path ./docs \
             --transform-for-static-hosting \
-            --hosting-base-path swift-emailaddress-type
+            --hosting-base-path swift-domain-type
 
           # Create root index.html redirect
           cat > ./docs/index.html << 'EOF'
           <!DOCTYPE html>
           <html>
             <head>
               <meta charset="utf-8">
-              <title>Redirecting to swift-emailaddress-type documentation</title>
-              <meta http-equiv="refresh" content="0; url=./documentation/emailaddress/">
-              <link rel="canonical" href="./documentation/emailaddress/">
+              <title>Redirecting to swift-domain-type documentation</title>
+              <meta http-equiv="refresh" content="0; url=./documentation/domain/">
+              <link rel="canonical" href="./documentation/domain/">
             </head>
             <body>
-              <p>Redirecting to <a href="./documentation/emailaddress/">swift-emailaddress-type documentation</a>...</p>
+              <p>Redirecting to <a href="./documentation/domain/">swift-domain-type documentation</a>...</p>
             </body>
           </html>
           EOF
diff --git a/README.md b/README.md
@@ -221,10 +221,10 @@ do {
 
 ## Related Packages
 
-- [swift-rfc-1035](https://github.com/swift-web-standards/swift-rfc-1035): DNS domain name types (RFC 1035)
-- [swift-rfc-1123](https://github.com/swift-web-standards/swift-rfc-1123): Internet host name types (RFC 1123)
-- [swift-rfc-5321](https://github.com/swift-web-standards/swift-rfc-5321): SMTP domain types (RFC 5321)
-- [swift-emailaddress-type](https://github.com/coenttb/swift-emailaddress-type): Type-safe email address validation using this domain type
+- [swift-rfc-1035](https://github.com/swift-web-standards/swift-rfc-1035): Swift implementation of RFC 1035: Domain Names - Implementation and Specification
+- [swift-rfc-1123](https://github.com/swift-web-standards/swift-rfc-1123): Swift implementation of RFC 1123: Requirements for Internet Hosts - Application and Support
+- [swift-rfc-5321](https://github.com/swift-web-standards/swift-rfc-5321): Swift implementation of RFC 5321: Simple Mail Transfer Protocol
+- [swift-emailaddress-type](https://github.com/coenttb/swift-emailaddress-type): A Swift package with a type-safe EmailAddress model
 
 ## Requirements
 
