Skip to content

Add support to diff DocC Archives #908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from
Draft

Add support to diff DocC Archives #908

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
c4d3935
Set up diff command line inputs.
emilyychenn Apr 15, 2024
7ac8ec7
Diff two DocC Archives to produce three lists: (1) The existing symbo…
emilyychenn Apr 18, 2024
098dc89
Diff now returns all symbols as links.
emilyychenn Apr 18, 2024
39bcd8a
Added support for exports and for docc archives, and return both addi…
emilyychenn Apr 29, 2024
b226fd9
Remove unused ChangeLogTemplate from CatalogTemplateKind.
emilyychenn Apr 30, 2024
670068a
Remove unused DiffRenderJSON.swift file.
emilyychenn Apr 30, 2024
8a798bf
Update help menu description and parameter naming.
emilyychenn Apr 30, 2024
278b3c2
Remove extra logging.
emilyychenn Apr 30, 2024
50346a8
Add logic to return added/removed symbols in an alphabetical list.
emilyychenn May 6, 2024
60f2f5b
Group symbols by highest level path component, and separate groups by…
emilyychenn May 7, 2024
36ae1a7
Add changes for demo; default diff is only modules, classes, protocol…
emilyychenn May 20, 2024
4a47bad
Cleanup GenerateChangeLog command, removing unnecessary functions.
emilyychenn May 20, 2024
05b5e76
Refactor to resolve some PR comments.
emilyychenn May 21, 2024
b938736
Use LogHandle instead of just print().
emilyychenn May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Remove extra logging.
  • Loading branch information
@emilyychenn
emilyychenn committed May 21, 2024
commit 278b3c274e9893167438371829809eaa1aa0a0ee
15 changes: 3 additions & 12 deletions Sources/SwiftDocCUtilities/ArgumentParsing/Subcommands/DiffDocCArchive.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,24 +98,13 @@ extension Docc.ProcessArchive {
let initialDocCArchiveAPIs: [URL] = try findAllSymbolLinks(initialPath: initialDocCArchivePath)
let newDocCArchiveAPIs: [URL] = try findAllSymbolLinks(initialPath: newerDocCArchivePath)

print("\nInitial DocC Archive: ")
printAllSymbols(symbols: initialDocCArchiveAPIs)

print("\nNew DocC Archive: ")
printAllSymbols(symbols: newDocCArchiveAPIs)

let initialSet = Set(initialDocCArchiveAPIs.map { $0 })
let newSet = Set(newDocCArchiveAPIs.map { $0 })

// Compute additions and removals to both sets
let additionsToNewSet = newSet.subtracting(initialSet)
let removedFromOldSet = initialSet.subtracting(newSet)

print("\nAdditions to New DocC Archive:")
printAllSymbols(symbols: Array(additionsToNewSet))
print("\nRemovals from Initial DocC Archive:")
printAllSymbols(symbols: Array(removedFromOldSet))

// Map identifier urls in differences to external urls
let additionsExternalURLs = Set(additionsToNewSet.map { findExternalLink(identifierURL: $0) })
let removalsExternalURLs = Set(removedFromOldSet.map { findExternalLink(identifierURL: $0) })
Expand Down Expand Up @@ -145,7 +134,9 @@ extension Docc.ProcessArchive {
for fileNameAndContent in Docc.ProcessArchive.DiffDocCArchive.changeLogTemplateFileContent(frameworkName: frameworkName, initialDocCArchiveVersion: initialDocCArchiveVersion, newerDocCArchiveVersion: newerDocCArchiveVersion, additionLinks: additionLinks, removalLinks: removalLinks) {
let fileName = fileNameAndContent.key
let content = fileNameAndContent.value
try FileManager.default.createFile(at: initialDocCArchivePath.deletingLastPathComponent().appendingPathComponent(fileName), contents: Data(content.utf8))
let filePath = initialDocCArchivePath.deletingLastPathComponent().appendingPathComponent(fileName)
try FileManager.default.createFile(at: filePath, contents: Data(content.utf8))
print("\nOutput file path: \(filePath)")
}
}

Expand Down