-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md according to Heroku CNB guidelines (#217)
- Loading branch information
1 parent
e073c01
commit d0a2bb6
Showing
1 changed file
with
40 additions
and
35 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,54 +1,59 @@ | ||
| # Heroku Cloud Native Procfile Buildpack | ||
| # Heroku Cloud Native Buildpack: Procfile | ||
|
|
||
| [](https://github.com/heroku/buildpacks-procfile/actions/workflows/ci.yml) | ||
| [![Cloud Native Buildpacks Registry: heroku/procfile][registry-badge]][registry-url] | ||
| [![CI on Github Actions: heroku/procfile][ci-badge]][ci-url] | ||
|
|
||
| This is a [Cloud Native Buildpack](https://buildpacks.io/) that replicates the behavior of | ||
| [`Procfile`](https://devcenter.heroku.com/articles/procfile) from non-CNB Heroku Builds. | ||
|
|
||
| It is written in Rust using the Cloud Native Buildpack framework [libcnb.rs](https://github.com/heroku/libcnb.rs). | ||
| `heroku/procfile` is the [Heroku Cloud Native Buildpack][heroku-buildpacks] | ||
| for Procfile applications. It replicates the behavior of [`Procfile`](https://devcenter.heroku.com/articles/procfile) | ||
| from builds on the Heroku Platform. | ||
|
|
||
| ## Development | ||
| > [!IMPORTANT] | ||
| > This is a [Cloud Native Buildpack][cnb], and is a component of the [Heroku Cloud Native Buildpacks][heroku-buildpacks] project, which is in preview. | ||
| ### Prerequisites | ||
| ## Usage | ||
|
|
||
| See [Development Environment Setup](https://github.com/heroku/libcnb.rs#development-environment-setup). | ||
| > [!NOTE] | ||
| > Before getting started, ensure you have the `pack` CLI installed. Installation instructions are available [here][pack-install]. | ||
| ### Test | ||
| To build an application codebase with a `Procfile` into a production image: | ||
|
|
||
| Run unit tests: | ||
|
|
||
| ``` | ||
| $ cargo test | ||
| ```bash | ||
| $ cd ~/workdir/sample-procfile-app | ||
| $ pack build sample-app --builder heroku/builder:22 | ||
| ``` | ||
|
|
||
| Run integration tests: | ||
|
|
||
| ``` | ||
| $ cargo test -- --ignored | ||
| Then run the image: | ||
| ```bash | ||
| docker run --rm -it -e "PORT=8080" -p 8080:8080 sample-app | ||
| ``` | ||
|
|
||
| Or to run all of the tests at the same time: | ||
| ## Application Requirements | ||
|
|
||
| ``` | ||
| $ cargo test -- --include-ignored | ||
| ``` | ||
| This buildpack requires a properly formatted [`Procfile`](https://devcenter.heroku.com/articles/procfile) | ||
| to exist in the root project directory. | ||
|
|
||
| ### Pack build example | ||
| ## Configuration | ||
|
|
||
| ``` | ||
| $ cargo libcnb package \ | ||
| && pack build procfile_example_app --builder heroku/builder:22 --buildpack target/buildpack/debug/heroku_procfile --path tests/fixtures/web_and_worker_procfile --verbose \ | ||
| && docker run -it --rm --entrypoint worker procfile_example_app | ||
| ``` | ||
| You may configure which processes are included in a build result by using a | ||
| YAML-like syntax with bash commands: | ||
|
|
||
| ```yaml | ||
| # Example Procfile | ||
| web: bundle exec rails server -p $PORT | ||
| worker: bundle exec rake jobs:work | ||
| ``` | ||
| $ pack inspect procfile_example_app | grep -A10 Processes | ||
| Processes: | ||
| TYPE SHELL COMMAND ARGS WORK DIR | ||
| web (default) bash echo 'this is the web process!' /workspace | ||
| worker bash echo 'this is the worker process!' /workspace | ||
| ``` | ||
| ## Releasing | ||
| ## Contributing | ||
| Issues and pull requests are welcome. See our [contributing guidelines](./CONTRIBUTING.md) if you would like to help. | ||
| [Deploy Cloud Native Buildpacks](https://github.com/heroku/languages-team/blob/main/languages/cnb/deploy.md) | ||
| [ci-badge]: https://github.com/heroku/buildpacks-procfile/actions/workflows/ci.yml/badge.svg | ||
| [ci-url]: https://github.com/heroku/buildpacks-procfile/actions/workflows/ci.yml | ||
| [cnb]: https://buildpacks.io | ||
| [classic-buildpack]: https://github.com/heroku/heroku-buildpack-procfile | ||
| [heroku-buildpacks]: https://github.com/heroku/buildpacks | ||
| [pack-install]: https://buildpacks.io/docs/for-platform-operators/how-to/integrate-ci/pack/ | ||
| [registry-badge]: https://img.shields.io/badge/dynamic/json?url=https://registry.buildpacks.io/api/v1/buildpacks/heroku/procfile&label=version&query=$.latest.version&color=DF0A6B&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAAXNSR0IArs4c6QAACSVJREFUaAXtWQ1sFMcVnp/9ub3zHT7AOEkNOMYYp4CQQFBLpY1TN05DidI2NSTF0CBFQAOBNrTlp0a14sipSBxIG6UYHKCO2ka4SXD4SUuaCqmoJJFMCapBtcGYGqMkDgQ4++52Z2e3b87es+/s+wNHVSUPsnZv9s2b97335v0MCI2NMQ2MaeD/WgP4FqQnX//2K4tVWfa0X+9+q/N4dfgWeESXPPjUUd+cu+5cYmMcPvzawQOtrdVG9GMaLxkD+OZDex6WVeUgwhiZnH1g62bNX4+sPpLGXvEkdPNzLd93e9y/cCnabIQJCnz+2Q9rNs9tjCdM9ltK9nGkb5jYxYjIyDJDSCLSV0yFHCr/XsObvQH92X+8u/b0SGvi5zZUn1joc/u2qapajglB4XAfUlQPoqpyRzxtqt8ZA+AIcQnZEb6WZSKCMSZUfSTLg8vv/86e3b03AztO/u3p7pE2fvInfy70TpiwRVKU5YqqygbTEWL9lISaiDFujbQu2VzGAIYzs5HFDUQo8WKibMzy0Yr7Ht5Td/Nyd0NLS3VQ0FesOjDurtwvPaWp6gZVc080TR2FQn0xrAgxkWVkLD8aBQD9cti2hWwAQimdImHpJTplcmXppF11hcV3Z/n92RsVVbuHc4bCod4YwZ0fHACYCCyS4Rg1AM6+ts2R+JOpNF/Okl/PyvLCeQc/j9O4Q+88hQWY/j+0gCOI84ycD0oRNxnSAVCqgYUFgDbTMeoWiBeAcRNRm8ZPD/uNCYfIZg6bTzXxxQKw4YCboH3SH7WSCRNxIQCb6fhiAYA0JgAgaQAQFhC0mY6MAYAzUIj9KN3jZoJbUEhWqQYBAJxZqX0tjlHGACyLtzKmM0pl2YKwmHzYcIjBt0kyuBhJVEKGHkKQ2DqT8xv+NWPEF9uOtOVNLz8B6XcqJVI+JGIIm4l8HCNVVSLfbctG8X9wOBDCFOl6+FRI19c07TvQjNDZRMyGSw8zGRdzUS7zVsnfyJtfSTHZLMlKkQ1lhUhmQ4cAl5XlgTwQu43IC4TK4PN6t8nMHR093bvOHPtZbGoeyijJeyznJISJPhWVvjAxL9u/VsZoHZGUif1u1a9EIbjLpQ4CgN/gegiE7uW2uffzgFV34tCK/yTinc78bQNwNllY9nKRy+feBE6xnEpS9HwoihwBQIgEGgdfs81mHjaeeeftJ/7prL2d56gBcIQoXfzbUpXKVUSWy8QcgQgkPMi0+IeQnZ899sYThxza0XiOOoABoQhUpJUypusRBFyO0W/ea/vLH1FrU0bd1mgAvD0ecNDRzGrl9pgkXB1RvlQw5dEyrKpVEI8+Ni19+6Xzr9+yby57sNrnK5y12u3xPhIOB8+d7mhbv//tTQaetmanROX5JueNXfzs7+7rPH7LffS1Rw9+zZvt34glktv3yaev4IIZK25CZPCKiAqVYx+yccONa589f/Xq4RG7qgT6ICtXv7ZU83i2ujXvLAQdmwiVXZyX/Lppn8Fo7ilnnW6xDwjnz+R31B915tJ53lj8++mu3JytxKVUSrIGCdiC8juMcNE9KyHmObkDkhKUwJZhdnHbqOvsC+xBVw5FuqpEmyxZtv+rvmzXNk3THsCQlETTIgaB7NojKSU7m/Zik+SeNAZyhCJobMjnNv8TENcWXKz/KBFvMX9uQe2EKQUz18kedb3syhrPuI6sgcQpwjQAeNyRPsrHBu1FLMLNFspYbXvHH96Mfhx4WbSorsh/5/hNbpdnmaIoqmnGnk8RNq/IVkl9czNi2P8+G5LkhPOq8J1Z7Aa37YZAyNg5p7vh8tA96tE8ecl3f7pc9bi3aJq3EGiRCTxwnLQjAnAY9QMRJbHdrKO+2sttTR/OXrjZ/+Wpdz8JGt+gaFqOaFjiM7BY3w/ALtl79OgwAA5/URSqYJGwbV6yLf58e+DC/gc+OdZ3/VsNZdTr3+bSXPfCfRFiSWqupACcjWxhdmYGFU19b9bsudO9Xl9xpHSwYksHh148oVYCC9gljcfeTQjAoZfA4hQEDXGjxZcz41PP5Mn3K5Is6dBjxyncWRJ9plWNYmgJIR+5PZrnIZeqpuxvBXcCFWiqWtWRQriGCZKCW81zQw8N1kDBkBFJgA5NomdaACKLoSnh0DGJsjdx9Tm4DQELhKAXEBukC0Sck7ARRrKhAgi45Rhkl/AtfQAWRCj4x5jw+dSssbAAzrzDEn0xNyAgpLGHQJU+ACC2QCsscmhTAxAuhFDm+cpm4oIrIwAiqKUWCIgghIEFBABoTlINASCE4arEphCsU1EPfhcWIGDlVBYQEgi2ElSJBqWSgofE6UF2sW8WCM5AOwJI8gE9M9g2GGTIJUnMsgkAEQ6Yah3IDQAsIzUAEbmEGJJlsqW2jZ+DEr4Y7m2TCicEMFOcAXF4xRkx9eAbNy+fORcIZzHDJb8KGz4Ot9lUhwiTbEQAJLEAFOeQOyQUNINdjIWrIsbNy6sYr2quH0HS+DFVlImYi01itSW0D/8vgLLHjR/2TQgkah8Ra8HFTjGOa06f3A797SCTCwWry8DSVXBvWhoJBgksLlM/3N6rw1xICOoCwXXOAlAU1tvBqzumdL18JcY7cwp+MH2cJG8CaVZgqPBE/HeG2FSWZCTi9NAhHFxkXYOzbpvznd2dZ3b19Bwf8Qb3AJqpLCgsrYRC6ecqJjMM4A+lxFB2SCbiLlWGucF5RXRzFgNK6yAzwzX551+MVswxABxOefmP3etS5a2YSuVizjkfBAo9l0tzyCDbSqKC7YUIu/daOFB3pbUxrf721B0rc/w+9zrYfK2K5QlhcCvnfFCigUr6L0ucDA3KeR8iYO3U8y8M6+ZGBDAgIc0vWl5BEakiijQTYmhkWpEVEBwOELgUt+y3QtysuXT21ahGoujSePl3/qpiRVK2wO3KY1ClyuJ8YHATcDPIyhQFud6JbfKr1vZz+xehd0a8e08GICKC318xzpejrpUQ3UAkaZK4yoGU/HduWts72hsPpyFnSpL2wjWlFNFfSoSWipqIWVYP1J27rwcCL839eF9PMgYpATiLJ01eOs2jaU+D03508cK/9iHUkm6F4LBI+hTlc9m0BSsVSufcCBkvzu7afSHpgrGPYxoY00BEA/8FOPrYBqYsE44AAAAASUVORK5CYII=&labelColor=white | ||
| [registry-url]: https://registry.buildpacks.io/buildpacks/heroku/procfile |