Skip to content

Commit e51b3ae

Browse files
committed
Merging develop to master in preparation for 1.3.0 release.
2 parents bc38402 + 1c64d62 commit e51b3ae

27 files changed

+1348
-706
lines changed

.coveralls.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
coverage_clover: clover.xml
2+
json_path: coveralls-upload.json

.gitattributes

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/.coveralls.yml export-ignore
2+
/.gitattributes export-ignore
3+
/.gitignore export-ignore
4+
/.travis.yml export-ignore
5+
/composer.lock export-ignore
6+
/docs/ export-ignore
7+
/phpcs.xml export-ignore
8+
/phpunit.xml.dist export-ignore
9+
/test/ export-ignore

.gitignore

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
vendor/
2-
.idea/
3-
phpunit.xml
1+
/clover.xml
2+
/coveralls-upload.json
3+
/phpunit.xml
4+
/vendor/

.travis.yml

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ language: php
55
cache:
66
directories:
77
- $HOME/.composer/cache
8-
- vendor
98

109
env:
1110
global:
12-
- COMPOSER_ARGS="--no-interaction --ignore-platform-reqs"
11+
- COMPOSER_ARGS="--no-interaction"
12+
- COVERAGE_DEPS="php-coveralls/php-coveralls"
1313

1414
matrix:
15-
fast_finish: true
1615
include:
1716
- php: 5.6
1817
env:
1918
- DEPS=lowest
2019
- php: 5.6
2120
env:
2221
- DEPS=locked
22+
- LEGACY_DEPS="phpunit/phpunit"
2323
- php: 5.6
2424
env:
2525
- DEPS=latest
@@ -29,36 +29,48 @@ matrix:
2929
- php: 7
3030
env:
3131
- DEPS=locked
32-
- CS_CHECK=true
32+
- LEGACY_DEPS="phpunit/phpunit"
3333
- php: 7
3434
env:
3535
- DEPS=latest
36-
- php: hhvm
36+
- php: 7.1
3737
env:
3838
- DEPS=lowest
39-
- php: hhvm
39+
- php: 7.1
4040
env:
4141
- DEPS=locked
42-
- php: hhvm
42+
- CS_CHECK=true
43+
- TEST_COVERAGE=true
44+
- php: 7.1
45+
env:
46+
- DEPS=latest
47+
- php: 7.2
48+
env:
49+
- DEPS=lowest
50+
- php: 7.2
51+
env:
52+
- DEPS=locked
53+
- php: 7.2
4354
env:
4455
- DEPS=latest
45-
allow_failures:
46-
- php: hhvm
47-
48-
notifications:
49-
irc: "irc.freenode.org#apigility-dev"
50-
email: false
5156

5257
before_install:
5358
- if [[ $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi
54-
- travis_retry composer self-update
5559

5660
install:
61+
- travis_retry composer install $COMPOSER_ARGS --ignore-platform-reqs
62+
- if [[ $LEGACY_DEPS != '' ]]; then travis_retry composer update $COMPOSER_ARGS --with-dependencies $LEGACY_DEPS ; fi
5763
- if [[ $DEPS == 'latest' ]]; then travis_retry composer update $COMPOSER_ARGS ; fi
5864
- if [[ $DEPS == 'lowest' ]]; then travis_retry composer update --prefer-lowest --prefer-stable $COMPOSER_ARGS ; fi
59-
- travis_retry composer install $COMPOSER_ARGS
60-
- composer show
65+
- if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry composer require --dev $COMPOSER_ARGS $COVERAGE_DEPS ; fi
66+
- stty cols 120 && composer show
6167

6268
script:
63-
- composer test
69+
- if [[ $TEST_COVERAGE == 'true' ]]; then composer test-coverage ; else composer test ; fi
6470
- if [[ $CS_CHECK == 'true' ]]; then composer cs-check ; fi
71+
72+
after_script:
73+
- if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry php vendor/bin/php-coveralls -v ; fi
74+
75+
notifications:
76+
email: false

CHANGELOG.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,46 @@
22

33
All notable changes to this project will be documented in this file, in reverse chronological order by release.
44

5-
## 1.2.4 - TBD
5+
## 1.3.0 - 2018-05-07
66

77
### Added
88

9-
- Nothing.
9+
- [#69](https://github.com/zfcampus/zf-apigility-documentation/pull/69) adds support for PHP 7.1 and 7.2.
10+
11+
- [#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) adds the ability to specify examples for fields.
12+
13+
### Changed
14+
15+
- [#62](https://github.com/zfcampus/zf-apigility-documentation/pull/62) updates the `ZF\Apigility\Documentation\Controller` to accept a `BasePath`
16+
view helper as a construction aregument; this is then used to prefix any generated links with
17+
the currently detected/configured base path to the application.
1018

1119
### Deprecated
1220

1321
- Nothing.
1422

1523
### Removed
1624

17-
- Nothing.
25+
- [#69](https://github.com/zfcampus/zf-apigility-documentation/pull/69) removes support for HHVM.
1826

1927
### Fixed
2028

21-
- Nothing.
29+
- [#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) provides a fix to configuration detection that removes an emitted
30+
notice when no zf-rpc and/or no zf-rest configuration is present.
31+
32+
- [#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) fixes the "api" route parameter constraint to accept `%` characters, which
33+
are often present when multi-segment namespaces are used for a given API name.
2234

2335
## 1.2.3 - 2016-10-11
2436

2537
### Added
2638

2739
- Nothing.
2840

41+
### Changed
42+
43+
- Nothing.
44+
2945
### Deprecated
3046

3147
- Nothing.

CONTRIBUTING.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

LICENSE.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
1-
Copyright (c) 2014-2016, Zend Technologies USA, Inc.
2-
1+
Copyright (c) 2014-2018, Zend Technologies USA, Inc.
32
All rights reserved.
43

54
Redistribution and use in source and binary forms, with or without modification,
65
are permitted provided that the following conditions are met:
76

8-
- Redistributions of source code must retain the above copyright notice,
9-
this list of conditions and the following disclaimer.
7+
- Redistributions of source code must retain the above copyright notice, this
8+
list of conditions and the following disclaimer.
109

11-
- Redistributions in binary form must reproduce the above copyright notice,
12-
this list of conditions and the following disclaimer in the documentation
13-
and/or other materials provided with the distribution.
10+
- Redistributions in binary form must reproduce the above copyright notice, this
11+
list of conditions and the following disclaimer in the documentation and/or
12+
other materials provided with the distribution.
1413

1514
- Neither the name of Zend Technologies USA, Inc. nor the names of its
1615
contributors may be used to endorse or promote products derived from this

README.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
ZF Apigility Documentation
2-
==========================
1+
# ZF Apigility Documentation
32

4-
[![Build Status](https://travis-ci.org/zfcampus/zf-apigility-documentation.png)](https://travis-ci.org/zfcampus/zf-apigility-documentation)
3+
[![Build Status](https://secure.travis-ci.org/zfcampus/zf-apigility-documentation.svg?branch=master)](https://secure.travis-ci.org/zfcampus/zf-apigility-documentation)
4+
[![Coverage Status](https://coveralls.io/repos/github/zfcampus/zf-apigility-documentation/badge.svg?branch=master)](https://coveralls.io/github/zfcampus/zf-apigility-documentation?branch=master)
55

6-
Introduction
7-
------------
6+
## Introduction
87

98
This Zend Framework module can be used with conjunction with Apigility in order to:
109

@@ -23,13 +22,11 @@ This module accomplishes all the above use cases by providing an endpoint to con
2322
(`/apigility/documentation[/:api[-v:version][/:service]]`), using content-negotiation to provide
2423
both HTML and JSON representations.
2524

26-
Requirements
27-
------------
25+
## Requirements
2826

2927
Please see the [composer.json](composer.json) file.
3028

31-
Installation
32-
------------
29+
## Installation
3330

3431
Run the following `composer` command:
3532

@@ -66,8 +63,7 @@ return [
6663
> If you use [zf-component-installer](https://github.com/zendframework/zf-component-installer),
6764
> that plugin will install zf-apigility-documentation as a module for you.
6865
69-
Configuration
70-
=============
66+
## Configuration
7167

7268
### User Configuration
7369

@@ -167,13 +163,11 @@ return [
167163
];
168164
```
169165

170-
ZF2 Events
171-
==========
166+
## ZF Events
172167

173168
This module has no events or listeners.
174169

175-
ZF2 Services
176-
============
170+
## ZF Services
177171

178172
### View Helpers
179173

0 commit comments

Comments
 (0)