Skip to content

Commit 9329392

Browse files
committed
Added Readme
1 parent f4dd1da commit 9329392

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

tools/api_refs/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,21 @@ nano phpdoc.dev.xml # Edit and make your changes. For example, target only your
6464
tools/api_refs/api_refs.sh ~/.composer/auth.json ./docs/api/php_api/php_api_reference-TMP
6565
```
6666

67+
### Creating a build of dev version
68+
69+
To build the reference for an unreleased version, set the following variables:
70+
71+
- `DXP_VERSION`
72+
- `BASE_DXP_BRANCH`
73+
- `VIRTUAL_DXP_VERSION`
74+
75+
For example, to build the API Reference based on the development version of the DXP before the 5.0.10 release, run:
76+
77+
``` bash
78+
DXP_VERSION=v5.0.x-dev BASE_DXP_BRANCH=5.0 VIRTUAL_DXP_VERSION=5.0.10 tools/api_refs/api_refs.sh ~/my/path/to/auth.json
79+
```
80+
81+
6782
### Test a branch
6883

6984
To load a package on a development branch instead of a released version,

0 commit comments

Comments
 (0)