Skip to content

Commit 047a199

Browse files
committed
re-add docs build script
1 parent 0c54b17 commit 047a199

File tree

6 files changed

+41
-1
lines changed

6 files changed

+41
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@ composer.phar
44
.php_cs.cache
55
composer.lock
66
docs/build
7+
docs/.phpdoc
78
phpunit/
89
.phpunit.result.cache

.ldrelease/build-docs.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/bin/bash
2+
3+
# This script assumes that it is running in a Docker container using the image
4+
# "ldcircleci/php-sdk-release", defined in https://github.com/launchdarkly/sdks-ci-docker
5+
6+
set -e
7+
8+
cd docs
9+
make

.ldrelease/config.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ publications:
44

55
circleci:
66
linux:
7-
image: ldcircleci/ld-php-sdk-release:1 # built in sdks-ci-docker project, contains PHP 7.2 + phpDocumentor
7+
image: ldcircleci/php-sdk-release:1 # built in sdks-ci-docker project, contains PHP 7.3 + phpDocumentor
88

99
documentation:
1010
githubPages: true
11+
title: LaunchDarkly PHP SDK phpredis integration

.ldrelease/publish-docs.sh

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#!/bin/bash
2+
3+
set -e
4+
5+
# Releaser will publish the docs to GitHub pages for us if we put a "docs.zip" artifact in ./artifacts
6+
7+
mkdir -p artifacts
8+
pushd docs/build/html
9+
rm -f docs.zip
10+
zip -r docs.zip *
11+
popd
12+
mv docs/build/html/docs.zip artifacts

docs/Makefile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
SOURCE_DIR = $(shell cd .. && pwd)
3+
PHPDOCUMENTOR = php $(LDTOOLS_DIR)/php/phpDocumentor.phar
4+
5+
.PHONY: html
6+
7+
html:
8+
rm -rf build/temp build/html
9+
$(PHPDOCUMENTOR) \
10+
-d $(SOURCE_DIR)/src \
11+
-t build/html \
12+
--visibility public \
13+
--defaultpackagename "SDK" \
14+
--title "${LD_RELEASE_DOCS_TITLE} ${LD_RELEASE_VERSION}"

src/LaunchDarkly/Impl/Integrations/PHPRedisFeatureRequester.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
use LaunchDarkly\Impl\Integrations\FeatureRequesterBase;
55

6+
/**
7+
* @internal
8+
*/
69
class PHPRedisFeatureRequester extends FeatureRequesterBase
710
{
811
/** @var array */

0 commit comments

Comments
 (0)