Merge pull request #58 from SwiftBuildTools/update-readme-for-0.2.0

Update readme for 0.2.0
ScottRobbins · Dec 2, 2020 · b53f0d7 · b53f0d7
2 parents b6c92f7 + 4444f3b
commit b53f0d7
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 23 deletions.
diff --git a/.changes.yml b/.changes.yml
@@ -15,4 +15,4 @@ files:
   - Removed
   - Fixed
   - Security
-  automaticallyRegenerate: true
+
diff --git a/.changes/unreleased/entries/BF801FBC-1130-43C8-8D45-499F3EA3D4F9.json b/.changes/unreleased/entries/BF801FBC-1130-43C8-8D45-499F3EA3D4F9.json
@@ -0,0 +1,7 @@
+{
+  "createdAtDate" : "2020-12-02T04:52:22Z",
+  "tags" : [
+    "Removed"
+  ],
+  "description" : "Remove automatic regeneration of files"
+}
diff --git a/.changes/unreleased/entries/DD9D2ACF-8BEA-47C2-BE1C-4CB1478357CE.json b/.changes/unreleased/entries/DD9D2ACF-8BEA-47C2-BE1C-4CB1478357CE.json
@@ -0,0 +1,7 @@
+{
+  "createdAtDate" : "2020-12-02T04:42:21Z",
+  "tags" : [
+    "Changed"
+  ],
+  "description" : "CI now uses swiftenv to ensure correct swift version is used on macOS"
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,10 @@ This file is auto-generated by Changes. Any modifications made to it will be ove
 - Updated Swift Argument Parser to 0.3.1
 - Add id to change entries and use as filename
 - Do not include version in release info json
+- CI now uses swiftenv to ensure correct swift version is used on macOS
+
+### Removed
+- Remove automatic regeneration of files
 
 ### Fixed
 - Fixed formatting in test files

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Changes
 
-Changes is CLI tool (and in the future a framework) for creating Changelog entries and generating Changelogs and other documents from those.  
+Changes is CLI tool (and in the future a framework) for tracking metadata around changes made to code, generating Changelogs and other documents from those entries.  
 
 **Note:** This is still in early development. API is subject to breakage between minor versions below 1.0.0
 
@@ -52,19 +52,19 @@ supports (if any are missing please open an issue).
 1. Download the needed binary
 
 ```bash
-$ curl -OL https://github.com/SwiftBuildTools/Changes/releases/download/<version>/changes-swift-5-2-<target>.tar.gz
+$ curl -OL https://github.com/SwiftBuildTools/Changes/releases/download/<version>/changes-swift-5-3-1-<target>-<dynamic|static>.tar.gz
 ```
 
 Or
 
 ```bash
-$ wget https://github.com/SwiftBuildTools/Changes/releases/download/<version>/changes-swift-5-2-<target>.tar.gz
+$ wget https://github.com/SwiftBuildTools/Changes/releases/download/<version>/changes-swift-5-3-1-<target>-<dynamic|static>.tar.gz
 ```
 
 2. Unpackage the binary
 
 ```bash
-$ tar -xvzf changes-swift-5-2-<target>.tar.gz 
+$ tar -xvzf changes-swift-5-2-<target>-<dynamic|static>.tar.gz 
 ```
 
 Put this executable somewhere in your PATH.

diff --git a/Sources/ChangesCLI/ChangelogManagerConfig.swift b/Sources/ChangesCLI/ChangelogManagerConfig.swift
@@ -3,7 +3,6 @@ struct ChangesConfig: Codable {
     let identifier: String
     let path: String
     let tags: [String]
-    let automaticallyRegenerate: Bool
     let footerText: String?
   }
 

diff --git a/Sources/ChangesCLI/Commands/Add.swift b/Sources/ChangesCLI/Commands/Add.swift
@@ -116,7 +116,6 @@ struct Add: ParsableCommand {
     try outputFolder.createFile(named: "\(UUID().uuidString).json").write(
       outputString
     )
-    try ChangelogGenerator().regenerateAutomaticallyRegeneratableFiles()
   }
 
   private func getTags(with config: ChangesConfig) -> [String] {

diff --git a/Sources/ChangesCLI/Commands/Init.swift b/Sources/ChangesCLI/Commands/Init.swift
@@ -25,7 +25,6 @@ struct Init: ParsableCommand {
           identifier: "changelog",
           path: "./CHANGELOG.md",
           tags: tags,
-          automaticallyRegenerate: true,
           footerText: nil
         )
       ]

diff --git a/Sources/ChangesCLI/Commands/Regenerate.swift b/Sources/ChangesCLI/Commands/Regenerate.swift
@@ -12,7 +12,7 @@ struct Regenerate: ParsableCommand {
       "Specify the files you would like to regenerate."
     )
   )
-  var identifiers: [String] = []
+  var identifiers: [String]
 
   func validate() throws {
     let loadedConfig = try ConfigurationLoader().load()
@@ -26,11 +26,6 @@ struct Regenerate: ParsableCommand {
   }
 
   func run() throws {
-    if identifiers.isEmpty {
-      try ChangelogGenerator().regenerateAutomaticallyRegeneratableFiles()
-    }
-    else {
-      try ChangelogGenerator().regenerateFiles(identifiers: identifiers)
-    }
+    try ChangelogGenerator().regenerateFiles(identifiers: identifiers)
   }
 }
diff --git a/Sources/ChangesCLI/Commands/ReleaseCommand.swift b/Sources/ChangesCLI/Commands/ReleaseCommand.swift
@@ -17,7 +17,6 @@ struct ReleaseCommand: ParsableCommand {
   func run() throws {
     let version = self.version ?? getVersion()
     try ReleaseCreator().createRelease(version: version)
-    try ChangelogGenerator().regenerateAutomaticallyRegeneratableFiles()
   }
 
   private func getVersion() -> Version {

diff --git a/Sources/ChangesCLI/Generate/ChangelogGenerator.swift b/Sources/ChangesCLI/Generate/ChangelogGenerator.swift
@@ -24,13 +24,6 @@ struct ChangelogGenerator {
     try regenerateFiles(files, loadedConfig: loadedConfig)
   }
 
-  func regenerateAutomaticallyRegeneratableFiles() throws {
-    let loadedConfig = try ConfigurationLoader().load()
-
-    let files = loadedConfig.config.files.filter(\.automaticallyRegenerate)
-    try regenerateFiles(files, loadedConfig: loadedConfig)
-  }
-
   private func regenerateFiles(
     _ files: [ChangesConfig.ChangelogFile],
     loadedConfig: LoadedChangesConfig