@@ -21,14 +21,14 @@ extension Docc.ProcessArchive {
21
21
/// Command line configuration.
22
22
static var configuration = CommandConfiguration (
23
23
commandName: " diff-docc-archive " ,
24
- abstract: " Produce a list of symbols added in the newer DocC Archive that did not exist in the initial DocC Archive . " ,
24
+ abstract: " Produce a markdown file saved as {FrameworkName}_ChangeLog.md containing the diff of added/removed symbols between the two provided DocC archives . " ,
25
25
shouldDisplay: true )
26
26
27
27
/// Content of the 'changeLog' template.
28
28
static func changeLogTemplateFileContent(
29
29
frameworkName: String ,
30
- initialDocCArchiveName : String ,
31
- newerDocCArchiveName : String ,
30
+ initialDocCArchiveVersion : String ,
31
+ newerDocCArchiveVersion : String ,
32
32
additionLinks: String ,
33
33
removalLinks: String
34
34
) -> [ String : String ] {
@@ -44,19 +44,19 @@ extension Docc.ProcessArchive {
44
44
45
45
Browse notable changes in \( frameworkName. localizedCapitalized) .
46
46
47
- ## Version: Diff between \( initialDocCArchiveName ) and \( newerDocCArchiveName )
47
+ ## Version: Diff between \( initialDocCArchiveVersion ) and \( newerDocCArchiveVersion )
48
48
49
49
50
50
### Change Log
51
51
52
52
#### Additions
53
- _New symbols added in \( newerDocCArchiveName ) that did not previously exist in \( initialDocCArchiveName ) ._
53
+ _New symbols added in \( newerDocCArchiveVersion ) that did not previously exist in \( initialDocCArchiveVersion ) ._
54
54
55
55
\( additionLinks)
56
56
57
57
58
58
#### Removals
59
- _Old symbols that existed in \( initialDocCArchiveName ) that no longer exist in \( newerDocCArchiveName ) ._
59
+ _Old symbols that existed in \( initialDocCArchiveVersion ) that no longer exist in \( newerDocCArchiveVersion ) ._
60
60
61
61
\( removalLinks)
62
62
@@ -68,9 +68,9 @@ extension Docc.ProcessArchive {
68
68
69
69
@Argument (
70
70
help: ArgumentHelp (
71
- " The name of the initial DocC Archive to be compared. " ,
72
- valueName: " initialDocCArchiveName " ) )
73
- var initialDocCArchiveName : String
71
+ " The version of the initial DocC Archive to be compared. " ,
72
+ valueName: " initialDocCArchiveVersion " ) )
73
+ var initialDocCArchiveVersion : String
74
74
75
75
@Argument (
76
76
help: ArgumentHelp (
@@ -81,9 +81,9 @@ extension Docc.ProcessArchive {
81
81
82
82
@Argument (
83
83
help: ArgumentHelp (
84
- " The name of the newer DocC Archive to be compared. " ,
85
- valueName: " newerDocCArchiveName " ) )
86
- var newerDocCArchiveName : String
84
+ " The version of the newer DocC Archive to be compared. " ,
85
+ valueName: " newerDocCArchiveVersion " ) )
86
+ var newerDocCArchiveVersion : String
87
87
88
88
@Argument (
89
89
help: ArgumentHelp (
@@ -142,7 +142,7 @@ extension Docc.ProcessArchive {
142
142
}
143
143
144
144
// Create markdown file with changes in the newer DocC Archive that do not exist in the initial DocC Archive.
145
- for fileNameAndContent in Docc . ProcessArchive. DiffDocCArchive. changeLogTemplateFileContent ( frameworkName: frameworkName, initialDocCArchiveName : initialDocCArchiveName , newerDocCArchiveName : newerDocCArchiveName , additionLinks: additionLinks, removalLinks: removalLinks) {
145
+ for fileNameAndContent in Docc . ProcessArchive. DiffDocCArchive. changeLogTemplateFileContent ( frameworkName: frameworkName, initialDocCArchiveVersion : initialDocCArchiveVersion , newerDocCArchiveVersion : newerDocCArchiveVersion , additionLinks: additionLinks, removalLinks: removalLinks) {
146
146
let fileName = fileNameAndContent. key
147
147
let content = fileNameAndContent. value
148
148
try FileManager . default. createFile ( at: initialDocCArchivePath. deletingLastPathComponent ( ) . appendingPathComponent ( fileName) , contents: Data ( content. utf8) )
0 commit comments