-
Notifications
You must be signed in to change notification settings - Fork 37
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.
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
add documentation and build script for Go wrapper #626
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
#!/usr/bin/env bash | ||
|
||
# Usage: ./build.sh [--release] | ||
|
||
check_command() { | ||
if ! command -v "$1" &>/dev/null; then | ||
printf '%s\n' "$1 is required to build locally. Please install $2." | ||
exit 1 | ||
fi | ||
} | ||
|
||
check_command cargo Rust | ||
check_command go Go | ||
check_command npm Node.js | ||
Comment on lines
+5
to
+14
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We generally presume the environment is correctly bootstraped. These checks can provide a false confidence since we don't validate the version of the scripts. |
||
|
||
REPO_ROOT="$(git rev-parse --show-toplevel)" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. instead of relying on |
||
GO_LIB_DIR="$REPO_ROOT/languages/go/internal/cinterface/lib" | ||
|
||
pushd "$REPO_ROOT" || exit 1 | ||
printf '%s\n\n' "Cleaning old builds..." | ||
rm -f languages/go/example/example && rm -rf "$GO_LIB_DIR" | ||
|
||
printf '%s\n\n' "Building binaries..." | ||
|
||
if [ "$1" = "--release" ]; then | ||
cargo build --release | ||
else | ||
cargo build | ||
fi | ||
|
||
npm i && npm run schemas | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We never want to run |
||
|
||
printf '%s\n\n' "Copying Go bindings to $GO_LIB_DIR..." | ||
mkdir -p "$GO_LIB_DIR" | ||
find target/debug -maxdepth 1 -type f -name "libbitwarden_c.*" -exec cp {} "$GO_LIB_DIR"/ \; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's a reference to the Also, the I don't think the extra copies are necessarily a concern, but only |
||
|
||
printf '%s\n\n' "Build complete!" | ||
printf '%s\n' "To run the Go example, set the following environment variables: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. shouldn't this all be part of README.md instead ? |
||
export API_URL=\"http://localhost:4000\" # your Bitwarden API URL | ||
export IDENTITY_URL=\"http://localhost:33656\" # your Bitwarden Identity URL | ||
export ACCESS_TOKEN=\"your-access-token\" # your Bitwarden access token | ||
export STATE_PATH=\"your-absolute-path\" # the absolute path to your state file | ||
export ORGANIZATION_ID=\"your-org-id\" # your Bitwarden organization ID | ||
export PROJECT_NAME=\"your-project-name\" # an arbitrary project name | ||
" | ||
|
||
printf '%s\n' "Then, run the example with: | ||
pushd $REPO_ROOT/languages/go/example | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
go mod tidy | ||
go run example.go | ||
popd | ||
" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why do we need a
build.sh
script that actually does not build the Go lang wrapper, but instead builds SDK ?Feels like that's something for the SDK itself, which we already have documented in the root README.md.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would agree, @tangowithfoxtrot maybe we can discuss what the heart of the PR is? I have an idea that I think you'll like 😄