Skip to content

Commit 51ca823

Browse files
author
Joerg Boeselt
committed
add changelog, lowercasing some doc files
1 parent fe34618 commit 51ca823

File tree

3 files changed

+130
-0
lines changed

3 files changed

+130
-0
lines changed

AUTHORS.md renamed to authors.md

File renamed without changes.

changelog.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
## Version 0.10.0 FutureReady
2+
3+
>This version is **NOT COMPATIBLE** with older lxHive versions. (server requirements, codebase, database model).
4+
5+
Currently there are no plans to release database migration functionality. Please launch a request to `[email protected]` if you need help with migrating records from older lxHive versions.
6+
7+
#### Summary
8+
Extensive changes in regards to stability, testability, reporting administration and configurability.
9+
This release focuses on support for modern server environments and advances in an overall simplification and refactoring process.
10+
11+
* PHP 7 support
12+
* Slim 3
13+
* Replace legacy Mongo Driver with [MongoDB](http://php.net/manual/en/set.mongodb.php)
14+
* Advanced reporting queries with the new ExtendedQuery Extension
15+
16+
#### Misc, General code refactor
17+
* Consolidation of exception handling
18+
* Code separation, restructuring and division into modules, controllers, services and APIs
19+
* Decoupling third-party dependencies (notably Slim)
20+
* Consistent use of dependency containers for services
21+
* Removing logic out of index.php into new Bootstrap module; index.php now only has 3 LOC
22+
* Support for Monolog handlers for production and development mode: ChromePHPHandler, FirePHPHandler, Streamhandler, ErrorLogHandler
23+
* Removal of obsolete code
24+
* Increase of code testability
25+
* Separation of autoloading for unit tests and benchmarks
26+
* Linting, PSR-1, CircleCI
27+
* Improved /about endpoint includes extensions and LRS information
28+
* Consolidation of agent and uuid processing
29+
30+
#### ExtendedQuery Extension (new)
31+
* Fragmented reporting queries, closely modelled on MongoDB, query language
32+
* Documentation in progress
33+
34+
#### Configuration Module (new)
35+
* Extensive model changes
36+
* Templates
37+
* Globally accessible config service
38+
* Version awareness
39+
* New authentication scopes configuration
40+
* Configuration model for extensions
41+
* Documented config template
42+
43+
#### Bootstrap Module (new)
44+
* New Bootstrap module loads configuration and boots app
45+
* Boot modes: Web (default), Console, Testing, Config, None
46+
* Service container creation according to boot modes
47+
48+
#### Parser Module (rewrite)
49+
* Combining parser logic in parser module
50+
* Switch payload parsing to stdClass
51+
52+
#### Controller Module (rewrite)
53+
* Migrate controller logic from ols Resource into new "Controller" module
54+
* Improved permission validation
55+
56+
#### Router Module (new)
57+
* Lightweight and extendable router API
58+
59+
#### Authentication Module (rewrite)
60+
* New centralised Auth Service is faster and easier to configure
61+
* Removed AuthScopes collection, services and models
62+
* Permission inheritance and user ID
63+
* Changes to oAuth and basicAuth services
64+
65+
#### Database/Storage module (replaced):
66+
* PHP 7 ready: switch to ‘ext-mongodb’, removed support for legacy `ext-mongo`
67+
* Complete new low-level Storage API
68+
* Performance improvements by removing all third-party dependencies
69+
* Basic schema
70+
* Collection Indexing
71+
* Query expression API
72+
* Started unifying document properties
73+
* Statement documents include user ID
74+
75+
#### Admin API (new)
76+
* Bundled administrative tasks into new API
77+
* Input validators
78+
* Most administrative tasks are now REST ready (next milestone)
79+
80+
#### Extensions API (new)
81+
* Installation
82+
* Configuration
83+
* Model
84+
* Controller
85+
* Symfony events
86+
87+
#### Validator Module (changes)
88+
* Slight improvements to JSON validator
89+
* Debug mode for HTTP errors
90+
* Conformance improvements
91+
92+
#### Admin Console (changes)
93+
* New multistep ./X setup command
94+
* Removed obsolete "AuthScopes" commands
95+
* ./X status command give LRS status report
96+
* Improved output styling and added command hints
97+
* Strict validation for emails and passwords
98+
99+
#### Unit test (new)
100+
* PHPUnit configurations, base classes, with instructions and examples
101+
* Started migration tests
102+
* Mongo test API
103+
104+
#### Benchmarking (new)
105+
* PHPBench support and configuration
106+
107+
#### Third Party support
108+
* Removed sokil/php-mongo
109+
* Switch to Slim 3 (see above); decoupling from code
110+
* General review of dependencies, removed obsolete ones, updated others
111+
112+
#### PHPDoc:
113+
* Removed "docs" folder with compiled documents to keep documentation current
114+
* Added bash script helper for documentation generation
115+
* Continued to add missing code documentation
116+
* Changes to Sami configuration
117+
118+
----
119+
120+
## Version 0.9.1
121+
122+
* include StatementRefs in StatementResults
123+
* mongo log
124+
* console improvements
125+
* migration script
126+
* default (token based) statement.authority
127+
* GET /statments format param implementation
128+
* improved oAuth views with configurable css, logo
129+
* statement attachments (multipart): support for utf-8 and base64
130+
* conformance improvements
File renamed without changes.

0 commit comments

Comments
 (0)