Skip to content
This repository was archived by the owner on Jul 28, 2022. It is now read-only.

Commit bc4cc16

Browse files
authored
Merge pull request #62 from greg0ire/merge_1.x
Merge 1.x
2 parents c153d7e + f3acbda commit bc4cc16

File tree

3 files changed

+45
-1
lines changed

3 files changed

+45
-1
lines changed

CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
11
# Change Log
22
All notable changes to this project will be documented in this file.
33
This project adheres to [Semantic Versioning](http://semver.org/).
4+
5+
## [1.1.0](https://github.com/sonata-project/GoogleAuthenticator/compare/1.0.2...1.1.0) - 2017-04-19
6+
### Changed
7+
- Changed `getUrl` adding a new parameter : `$issuer`
8+
9+
### Deprecated
10+
- Extending any class defined in the package is deprecated
11+
12+
### Fixed
13+
- paths in sample code have been fixed
14+
15+
### Removed
16+
- internal test classes are now excluded from the autoloader
17+
18+
### Security
19+
- now generation of the secret is cryptographically strong.
20+
- Implemented constant time codes comparison

CONTRIBUTING.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,29 @@ php-cs-fixer fix --verbose
7272

7373
#### The documentation
7474

75-
The documentation is mostly written with the `rst` format. You can test the doc rendering with the `make docs` command.
75+
The documentation is mostly written with the `rst` format, and can be found in the `Resources/doc` directory.
76+
You can test the doc rendering with the `make docs` command, but to do this, you will need [Sphinx][sphinx_install].
77+
Just like php dependencies can be managed with Composer, python dependencies can be managed with [pip][pip_install].
78+
To get sphinx, simply run the following command.
79+
80+
```bash
81+
pip install --requirement Resources/doc/requirements.txt --user
82+
```
83+
84+
Some python binaries should be downloaded in `~/.local/bin`,
85+
[modify your `$PATH` environment variable](http://www.linfo.org/path_env_var.html)
86+
so that it contains this path and then, from the root of the project, run `make docs`
87+
88+
If `make docs` is successful, you should be able to see your modifications:
89+
90+
```bash
91+
$YOUR_FAVORITE_BROWSER Resources/doc/_build/html/index.html
92+
```
7693

7794
If your PR contains a new feature, you must add documentation for it.
95+
Of course, you can also create PRs consisting only in documentation changes.
96+
97+
Documentation contributions should comply with [the Symfony documentation standards][sf_docs_standards].
7898

7999
#### The tests
80100

@@ -317,3 +337,7 @@ This is a consensus made on #4242 in addition to #1337.
317337
We agreed that blank color is boring and so deja vu. Pink is the new way to do.
318338
```
319339
(Obviously, this commit is fake. :wink:)
340+
341+
[sphinx_install]: http://www.sphinx-doc.org/en/stable/
342+
[pip_install]: https://pip.pypa.io/en/stable/installing/
343+
[sf_docs_standards]: https://symfony.com/doc/current/contributing/documentation/standards.html

UPGRADE-1.x.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
UPGRADE 1.x
22
===========
33

4+
UPGRADE FROM 1.0 to 1.1
5+
=======================
6+
47
### Closed API
58

69
Extending any class defined in this library is now deprecated

0 commit comments

Comments
 (0)