-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOCS: create DEVELOPMENT.md docs (#95)
- Loading branch information
Showing
3 changed files
with
85 additions
and
71 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
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 |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# Local development | ||
|
||
## Build/package | ||
|
||
### Using the docker approach | ||
|
||
If you don't want to install any of the dependencies you might need to compile and install the library then you can use the Dockerfile. | ||
|
||
```bash | ||
## To prepare the build docker container | ||
PHP_VERSION=7.2 make -f .ci/Makefile prepare | ||
|
||
## To compile the library | ||
PHP_VERSION=7.2 make -f .ci/Makefile build | ||
|
||
## To test the library | ||
PHP_VERSION=7.2 make -f .ci/Makefile test | ||
|
||
## To install the library | ||
PHP_VERSION=7.2 make -f .ci/Makefile install | ||
|
||
## To install with composer | ||
PHP_VERSION=7.2 make -f .ci/Makefile composer | ||
|
||
## Help goal will provide further details | ||
make -f .ci/Makefile help | ||
``` | ||
|
||
_NOTE_: `PHP_VERSION` can be set to a different PHP version. | ||
|
||
To generate the packages then you can use the `packaging/Dockerfile`, see the below commands: | ||
|
||
| :warning: :construction: **WARNING: The packaging stage is still in development!** | | ||
| --- | | ||
|
||
```bash | ||
## To build the docker image that will be used later on for packaging the project | ||
make -C packaging build | ||
|
||
## To create the rpm package | ||
make -C packaging rpm | ||
|
||
## To create the deb package | ||
make -C packaging deb | ||
|
||
## To create all the packages that are supported | ||
make -C packaging package | ||
|
||
## To list the metadata info of the above generated packages | ||
make -C packaging info | ||
|
||
## To test the installation in debian | ||
make -C packaging deb-install | ||
|
||
## Help goal will provide further details | ||
make -C packaging help | ||
``` | ||
|
||
_NOTE_: current implementation requires to use `make -C packaging <target>` since the workspace | ||
is mounted as a volume. | ||
|
||
## Documentation | ||
|
||
To build the documentation for this project you must first clone the [`elastic/docs` repository](https://github.com/elastic/docs/). Then run the following commands: | ||
|
||
```bash | ||
# Set the location of your repositories | ||
export GIT_HOME="/<fullPathTYourRepos>" | ||
|
||
# Build the PHP documentation | ||
$GIT_HOME/docs/build_docs --doc $GIT_HOME/apm-agent-php/docs/index.asciidoc --chunk 1 --open | ||
``` |
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