diff --git a/Configs/local-sdk.yml b/Configs/local-sdk.yml new file mode 100644 index 0000000000..89d58c7f2c --- /dev/null +++ b/Configs/local-sdk.yml @@ -0,0 +1,3 @@ +packages: + BitwardenSdk: + path: ../sdk/languages/swift diff --git a/README.md b/README.md index 7c5f1e3835..9ba22742d6 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,9 @@ $ Scripts/bootstrap.sh ``` + > **Hint** + > For development purposes it's possible to use a local build of the Bitwarden SDK by setting the environment variable `LOCAL_SDK` to `true` before running the bootstrap script. Review [Linking SDK to clients](https://contributing.bitwarden.com/getting-started/sdk/#linking-the-sdk-to-clients) for more details. + > **Note** > Because `Scripts/bootstrap.sh` is how the project is generated, `bootstrap.sh` will need to be run every time the project configuration or file structure has changed (for example, when files have been added, removed or moved). It is typically best practice to run `bootstrap.sh` any time you switch branches or pull down changes. diff --git a/project.yml b/project.yml index 98108c910c..c578e089fb 100644 --- a/project.yml +++ b/project.yml @@ -17,6 +17,10 @@ options: settings: MARKETING_VERSION: 2024.6.0 # Bump this for a new version update. CURRENT_PROJECT_VERSION: 1 +include: + - path: Configs/local-sdk.yml + relativePaths: false + enable: ${LOCAL_SDK} packages: BitwardenSdk: url: https://github.com/bitwarden/sdk-swift