https://github.com/giginet/scipio-s3-storage

Scipio cache storage backend for AWS S3
https://github.com/giginet/scipio-s3-storage

Last synced: 27 days ago
JSON representation

Scipio cache storage backend for AWS S3

• Host: GitHub
• URL: https://github.com/giginet/scipio-s3-storage
• Owner: giginet
• License: mit
• Created: 2023-03-17T09:55:05.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-22T05:27:55.000Z (6 months ago)
• Last Synced: 2024-05-22T14:36:56.313Z (6 months ago)
• Language: Swift
• Homepage:
• Size: 240 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ScipioS3Storage

[Scipio](https://github.com/giginet/Scipio) cache storage backend for AWS S3.

## Usage

`scipio` CLI doesn't provide a way to set custom cache storage backend.

You have to prepare build script using `ScipioKit`.

```swift

import ScipioKit

import ScipioS3Storage

// Define S3 Storage settings

let config = S3StorageConfig(

    authenticationMode: .authorized(

        accessKeyID: "AWS_ACCESS_KEY_ID", 

        secretAccessKey: "AWS_SECRET_ACCESS_KEY"

    ),

    bucket: "my-bucket",

    region: "ap-northeast-1",

    endpoint: URL(string: "https://my-s3-bucket.com")!

)

// Instantiate S3Storage

let s3Storage = try S3Storage(config: config)

// Define Scipio Runner options

let options = Runner.Options(

    baseBuildOptions: .init(

        buildConfiguration: .release,

        isSimulatorSupported: false,

        isDebugSymbolsEmbedded: false,

        frameworkType: .static,

        extraBuildParameters: nil,

        enableLibraryEvolution: false

    ),

    buildOptionsMatrix: [:],

    cacheMode: .storage(s3Storage, [.consumer, .producer]),

    overwrite: true,

    verbose: verbose

)

// Create Scipio Runner in Prepare mode

let runner = Runner(

    mode: .prepareDependencies,

    options: options

)

// Run for your package description

try await runner.run(

    packageDirectory: packagePath,

    frameworkOutputDir: .default

)

```

### Authorization Mode

`S3Storage` have two authorization modes.

`.authorized` requires AWS credential to upload/download build artifacts. 

It's good for both cache producer and consumer.

Using `.usePublicURL` mode, S3 client attempt to fetch build artifacts from Public URL.

It doesn't need any authentication. It's good for cache consumers.

In this mode, client can't upload artifacts. So it must not become producers.

If you want to use non-authenticated mode, you have to upload artifacts from producers with `shoudPublishObject` option.

This option indicates ACL to be `publicRead`. It means all artifacts will become public.

```swift

let producerConfig = S3StorageConfig(

    authenticationMode: .authorized(

        accessKeyID: "AWS_ACCESS_KEY_ID", 

        secretAccessKey: "AWS_SECRET_ACCESS_KEY"

    ),

    bucket: "my-bucket",

    region: "ap-northeast-1",

    endpoint: URL(string: "https://my-s3-bucket.com")!,

    shouldPublishObject: true

)

let consumerConfig = S3StorageConfig(

    authenticationMode: .usePublicURL,

    bucket: "my-bucket",

    region: "ap-northeast-1",

    endpoint: URL(string: "https://my-s3-bucket.com")!

)

```