-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Minor README fixes for Salesforce Functions buildpacks
- Loading branch information
Showing
2 changed files
with
15 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,12 @@ | ||
| # Heroku Cloud Native JVM Function Invoker Buildpack | ||
| # Salesforce JVM Function Invoker Buildpack | ||
| [](https://github.com/heroku/buildpacks-jvm/actions/workflows/ci.yml) | ||
| [](https://registry.buildpacks.io/buildpacks/heroku/jvm-function-invoker) | ||
|
|
||
| ## Requirements | ||
| * [Rust](https://www.rust-lang.org/tools/install) via `rustup`. | ||
| * `x86_64-unknown-linux-musl` Rust target: `rustup target add x86_64-unknown-linux-musl` | ||
| * [cargo-make](https://crates.io/crates/cargo-make): `cargo install cargo-make` | ||
| * [musl libc](https://www.musl-libc.org/) | ||
| * Linux (Debian): `sudo apt install musl-tools` | ||
| * MacOS via [homebrew-musl-cross](https://github.com/FiloSottile/homebrew-musl-cross): `brew install FiloSottile/musl-cross/musl-cross` | ||
| * libssl-dev | ||
| * Linux (Debian): `sudo apt install libssl-dev` | ||
| * MacOS: `brew install openssl` | ||
| * [pack](https://buildpacks.io/docs/tools/pack/) (for local development) | ||
| This buildpack is designed to work in conjunction with other Heroku buildpacks and cannot be used independently. It | ||
| installs necessary components for Salesforce Functions implemented in a JVM language and pre-processes a function. | ||
|
|
||
| ## Usage | ||
| This buildpack targets `x86_64-unknown-linux-musl` as the platform for the buildpack. It uses [`libcnb.rs`](https://github.com/heroku/libcnb.rs) as the language binding for buildpacks which cames with tooling for cross-compilation and packagaing. | ||
|
|
||
| ### Development | ||
| Use [`libcnb-cargo`](https://github.com/heroku/libcnb.rs/tree/main/libcnb-cargo) to cross-compile and build the buildpack for local development and testing: | ||
|
|
||
| ```shell | ||
| $ cargo libcnb package | ||
| ``` | ||
|
|
||
| ### Production | ||
| A production release can also be build with `libcnb-cargo` by passing in the `--release` flag: | ||
|
|
||
| ```shell | ||
| $ cargo libcnb package --release | ||
| ``` | ||
|
|
||
| ### Testing | ||
| To run the unit + doc tests: | ||
| ```shell | ||
| $ cargo test | ||
| ``` | ||
| > [!WARNING] | ||
| > Salesforce Functions [will be EOL on January 31, 2025](https://devcenter.heroku.com/articles/salesforce-functions-retirement). | ||
| ## License | ||
| See [LICENSE](../../LICENSE) file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,9 @@ | ||
| # Heroku Cloud Native Java Function Buildpack | ||
| [](https://github.com/heroku/buildpacks-jvm/actions/workflows/ci.yml) | ||
| [](https://registry.buildpacks.io/buildpacks/heroku/java-function) | ||
|
|
||
| > [!WARNING] | ||
| > Salesforce Functions [will be EOL on January 31, 2025](https://devcenter.heroku.com/articles/salesforce-functions-retirement). | ||
| ## License | ||
| See [LICENSE](../../LICENSE) file. |