Sherpa Bundles with CI - install, build, & deploy

[aritchie]

We use MAUI Sherpa to build a bundle containing environments, secrets, profiles, certificates, & more. WE then encrypt that - pass the bundle anywhere to build, including your CI services (GitHub, AzDo, etc).

Bundle Internals - Initial thoughts for "Install" phase

{
    "Variables": {
        "SentryDsn": "https://myapp"
    },
    "Production": {
        "Variables":{
            "Hello" : "World",
            "BaseUrl": "https://myapi.com",
            "SentryDsn": "https://myapp.production"
        },
        "Android": {
            "Keystore": "base64 encoded keystore file",
            "KeyAlias": "key alias",
            "KeyPassword": "key password",
            "Variables":{
                "Hello": "Android World",
                "FirebaseApiKey": "firebase api key"
            }
        },
        "iOS":{
            "ProvisioningProfile": "base64 encoded provisioning profile",
            "Certificate": "base64 encoded certificate",
            "CertificatePassword": "certificate password",
            "Variables":{
                "Hello": "iOS World"
            }
        },
        "MacOS": {
            "ProvisioningProfile": "base64 encoded provisioning profile",
            "Certificate": "base64 encoded certificate",
            "CertificatePassword": "certificate password",
            "Variables":{
                "Hello": "MacOS World"
            }
        },
        "MacCatalyst": {
            "ProvisioningProfile": "base64 encoded provisioning profile",
            "Certificate": "base64 encoded certificate",
            "CertificatePassword": "certificate password",
            "Variables":{
                "Hello": "MacCatalyst World"
            }
        },
        "Windows": {
            "Certificate": "base64 encoded certificate",
            "CertificatePassword": "certificate password",
            "Variables":{
                "Hello": "Windows World"
            }
        }
    },
    "Development": {
    }
}

CLI Thoughts

sherpacli.exe myproject.sherpabundle -environment:production -platform:android/ios/windows/etc (multiple - what about parallel builds?)
- action: install, build, deploy OR all OR multiple

TODO

1. Deployments
2. Builds
3. Versioning

Need to consider the following output variables from different phases

• Build phase should output the ipa/exe/aab file path

This feature could/should overlap with #129

[aritchie]

Random brain dump from livestream on June 26

// sherpacli.exe myproject.sherpabundl -variable="SentryDsn="  -replacetoken:"buildNumber={{ BuildId }}" -project:csproj -environment:production -platform:android/ios/windows/etc -step:setup|build|deploy (multiple - what about parallel builds?)
    // action: install, build, deploy OR all OR multiple
// next up: deployments
// builds & versioning
// output variables: ipa/aab file path, version number, 
// infer build - look for global.json OR look at TFM and install latest - then infer XCODE version, Android SDK version, & Workload Set version
{
    "Build":{
        "Variables": {
            "SentryDsn": "https://myapp"
        }
    },
    "Production": {
        "Variables": {
            "Hello" : "World",
            "ApiBaseUrl": "https://myapi.com",
            "SentryDsn": "https://myapp.production"
        },
        "Android": {
            "Setup":{
                "Keystores:[{
                    "Content": "base64 encoded keystore file",
                    "KeyAlias": "key alias",
                    "KeyPassword": "key password"
                }]
            },
            "Build":{
                "Variables":{
                    "ApplicationId": "org.mycompany.myapp",
                    "ApplicationName": "My Name",
                    "ApplicationVersion": "1.0.${buildNumber}", // ${buildNumber} is a variable passed in via command line - ERROR if not provided
                    "MyOwnProperty": "My Own Value"
                }
            },
            "Deploy":{
                // multiples - firebase, playstore channels, amazon, etc
                "GoogleKey": ""
            }
        },
        "iOS":{
            "Setup":{
                // this should cover widget & standard stuff
                "Profiles":[{
                    "Content": "Base64 value"
                }],
                "Certificates:[{
                    "Content": "base64 encoded certificate",
                    "Password": "certificate password"
                }]
            },
            "Build":{
                "Variables":{
                    "Hello": "iOS World"
                }
            },
            "Deploy":[
                {
                    "provider": "TestFlight",
                    "apiKey": "base64 encoded api key"
                }, {
                    "provider": "Firebase",
                    "apiKey": "firebase api key"
                }
                // Allan says testflight only, Jon is P.I.T.A about this
                    // Jon wants useless Firebase - INSERT WHY MEME HERE
            ]
        },
        "MacOS": {
            "ProvisioningProfile": "base64 encoded provisioning profile",
            "Certificate": "base64 encoded certificate",
            "CertificatePassword": "certificate password",
            "Variables":{
                "Hello": "MacOS World"
            }
        },
        "MacCatalyst": {
            "ProvisioningProfile": "base64 encoded provisioning profile",
            "Certificate": "base64 encoded certificate",
            "CertificatePassword": "certificate password",
            "Variables":{
                "Hello": "MacCatalyst World"
            }
        },
        "Windows": {
            "Certificate": "base64 encoded certificate",
            "CertificatePassword": "certificate password",
            "Variables":{
                "Hello": "Windows World"
            }
        }
    },
    "Development": {
    }
}

• msbuild properties just becomes environment variables in the build process, so we can use them in our csproj and other files
• we pass all env vars to the build step automatically
• All variables are already updated with their replace tokens (computed)

// we run this process exec in the sherpa bundle cli
// we don't have to worry about exposing secrets in the build process logs
// we don't pass in application version, because we searched replace already?
dotnet build -p:ApplicationVersion=1.0.0

csproj/msbuild

<PropertyGroup>

    <ApplicationVersion Condition="'$(ApplicationVersion)' == ''">1.0</ApplicationVersion>
    <ApplicationVersion>${ApplicationVersion}</ApplicationVersion>
</PropertyGroup>

Constants.cs

public static class Constants
{
#if DEBUG
    public const string ApiUrl = "https://api-dev.example.com";
#else    
    public const string ApiUrl = "${ApiUrl}";
#endif
}

Info.plist

<version>Version</version>
<string>${ApplicationVersion}</string>