Skip to content

[PM-7587] Support conditionally loading local sdk #960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 1, 2024
Merged

[PM-7587] Support conditionally loading local sdk #960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc141eb
Support conditionally loading local sdk
Hinton Sep 23, 2024
1afc567
Add a note to readme
Hinton Sep 26, 2024
1ec9f89
Update link
Hinton Sep 27, 2024
3473f2e
Fix link
Hinton Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Configs/local-sdk.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
packages:
BitwardenSdk:
path: ../sdk/languages/swift
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 4 additions & 0 deletions project.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down