Version bump script

Makefile

@@ -1,2 +1,19 @@
+XCODE_PROJECT = ReadBeeb.xcodeproj/project.pbxproj
+TOPICS_FILE = ReadBeeb/Files/Topics.json
+
+release-version:
+	bin/version-bump --xcode-project $(XCODE_PROJECT) --version $(VERSION)
+
+release-major:
+	bin/version-bump --xcode-project $(XCODE_PROJECT) --bump-type major
+
+release-minor:
+	bin/version-bump --xcode-project $(XCODE_PROJECT) --bump-type minor
+
+release-patch:
+	bin/version-bump --xcode-project $(XCODE_PROJECT) --bump-type patch
+
+release: release-patch
+
 topics:
-	bin/fetch-topics $(API_KEY) > ReadBeeb/Files/Topics.json
+	bin/fetch-topics $(API_KEY) > $(TOPICS_FILE)

README.md

@@ -36,6 +36,9 @@ This project is for educational and research purposes only.
 
 ## Development
 
+This repository contains the ReadBeeb-specific logic and GUI code.
+Logic related to the BBC News API should be contributed to [bbc-news-swift](https://github.com/bilaalrashid/bbc-news-swift).
+
 Prerequisites:
 - [SwiftLint](https://github.com/realm/SwiftLint)
 - [Swift Package Manager](https://www.swift.org/documentation/package-manager/)
@@ -49,11 +52,24 @@ open ReadBeeb/ReadBeeb.xcodeproj
 
 Full contributing guidelines can be found in [CONTRIBUTING.md](CONTRIBUTING.md).
 
-## Release
+## Tools
 
-1. Update the list of installed topics:
+To update the list of installed topics:
 ```
 make topics API_KEY=<BBC News OAuth2 Token>
 ```
-2. Bump the version and build number in [project.pbxproj](ReadBeeb.xcodeproj/project.pbxproj/)
-3. Creating a matching tag and release once merged into `main`
+
+## Release
+
+On the `main` branch:
+1. Bump the version and build number, and tag the project
+```
+make release # Defaults to patch
+make release-<major|minor|patch>
+make release-version VERSION=<version>
+```
+2. Push to the remote
+```
+git push --tags
+```
+3. Create a corresponding [release](https://github.com/bilaalrashid/ReadBeeb/releases/new) on GitHub

ReadBeeb/Screens/SettingsScreen.swift

@@ -26,6 +26,21 @@ struct SettingsScreen: View {
     @AppStorage(Constants.UserDefaultIdentifiers.service)
     private var service = Service.english.rawValue
 
+    /// The text displayed as a footer
+    var footerText: String {
+        let credit = "A Bilaal Rashid project"
+
+        guard let version = Bundle.main.object(forInfoDictionaryKey: "CFBundleShortVersionString") as? String else {
+            return credit
+        }
+
+        guard let build = Bundle.main.object(forInfoDictionaryKey: "CFBundleVersion") as? String else {
+            return credit
+        }
+
+        return "Version \(version) (\(build))\n\(credit)"
+    }
+
     var body: some View {
         List {
             Section {
@@ -60,7 +75,7 @@ struct SettingsScreen: View {
             }
 
             Section(
-                footer: NavigationLink("A Bilaal Rashid project") {
+                footer: NavigationLink(self.footerText) {
                     LogScreen()
                 }
                     .buttonStyle(.plain)

bin/version-bump

@@ -0,0 +1,114 @@
+#!/usr/bin/env bash
+
+# version-bump
+# Bumps the version number of an Xcode project and increments the build number.
+#
+# Usage: ./version-bump --xcode-project <path> [--bump-type <major|minor|patch>] [--version <version>]
+
+### Functions
+
+function semver_major_bump {
+    local version="$1"
+    echo "$version"| awk -F. -v OFS=. '{$1++; $2=$3=0; print}'
+}
+
+function semver_minor_bump {
+    local version="$1"
+    echo "$version"| awk -F. -v OFS=. '{$2++; $3=0; print}'
+}
+
+function semver_patch_bump {
+    local version="$1"
+    echo "$version"| awk -F. -v OFS=. '{$3++; print}'
+}
+
+function get_current_version {
+    grep -Po "MARKETING_VERSION = \K([0-9]+\.[0-9]+(?:\.[0-9]+)?)" "$xcode_project" | awk -F. '{printf "%d.%d.%d\n", $1, ($2?$2:0), ($3?$3:0)}' | head -n1
+}
+
+function bump_version {
+    local xcode_project="$1"
+    local version="$2"
+    perl -pi -e "s/\bMARKETING_VERSION = [0-9]+(\.[0-9])+;$/MARKETING_VERSION = $version;/g" "$xcode_project"
+}
+
+### Main
+
+while [ $# -gt 0 ]; do
+    case "$1" in
+        --xcode-project)
+            xcode_project="$2"
+            shift 2
+            ;;
+        --version)
+            version="$2"
+            shift 2
+            ;;
+        --bump-type)
+            bump_type="$2"
+            shift 2
+            ;;
+        *)
+            echo "Error: Invalid option"
+            exit 1
+            ;;
+    esac
+done
+
+if [ -z "$xcode_project" ]; then
+    echo "error: Please specify the path to the Xcode project file using --xcode-project."
+    exit 1
+fi
+
+if [ -z "$bump_type" ] && [ -z "$version" ]; then
+    echo "error: Please specify either a bump type or version string using --bump-type or --version."
+    exit 1
+fi
+
+if [ -z "$version" ]; then
+    case "$bump_type" in
+    major)
+        version=$(semver_major_bump "$(get_current_version)")
+        ;;
+    minor)
+        version=$(semver_minor_bump "$(get_current_version)")
+        ;;
+    patch)
+        version=$(semver_patch_bump "$(get_current_version)")
+        ;;
+    *)
+        echo "Error: Invalid option passed to --bump-type"
+        exit 1
+      ;;
+    esac
+
+    echo "No version specified, bumping to $version"
+fi
+
+# Make sure working directory is clean.
+if output=$(git status --porcelain) && [ -n "$output" ]; then
+    printf "error: Please commit any uncommitted files before proceeding:\n%s\n" "$output"
+    exit 1
+fi
+
+# Make sure we are on primary branch
+branch=$(git rev-parse --abbrev-ref HEAD)
+if [[ "$branch" != "master" && "$branch" != "main" ]]; then
+    echo "error: Please switch to the main or master branch before proceeding."
+    exit 1
+fi
+
+# Increment the build number
+agvtool bump
+new_build=$(agvtool vers -terse)
+
+# Update the version number
+bump_version "$xcode_project" "$version"
+new_version=$(get_current_version)
+
+# Commit
+git add .
+git commit -m "Bump to v$new_version($new_build)"
+
+# Tag
+git tag -a "v$new_version" -m "Bump to v$new_version($new_build)"