Skip to content

[2.8] Modify 2.8 upgrade doc - key option is deprecated. #23826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

[2.8] Modify 2.8 upgrade doc - key option is deprecated. #23826

wants to merge 2 commits into from

Conversation

sampart
Copy link

@sampart sampart commented Aug 8, 2017

Q A
Branch? 2.8
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Tests pass? no, but this is only a documentation change - I don't think it's my change that has broken them.
Fixed tickets n/a
License MIT
Doc PR n/a

The 2.8.0 section of the CHANGELOG for the Security bundle has two items in it

  • deprecated the key setting of anonymous, remember_me and http_digest in favor of the secret setting.
  • deprecated the intention firewall listener setting in favor of the csrf_token_id.

The first of these isn't also in the Symfony upgrade guide, but the second is.

This PR adds the missing item (deprecated key setting) into the Symfony upgrade guide.

@@ -546,6 +546,9 @@ Security

* The `VoterInterface::supportsClass` and `supportsAttribute` methods were
deprecated and will be removed from the interface in 3.0.

* The the `key` setting of `anonymous`, `remember_me` and `http_digest`
is deprecated, and will be removed in 3.0. Use `secret` instead.
Copy link
Contributor

@sstok sstok Aug 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use the `secret` option instead.

Oh wait, the Bundle upgrade guide doesn't mention this :) better to wait for a merge to decide.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy to make this change, but I'll wait for someone else to confirm that it's needed, then.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add a config example showing the difference. You can borrow the one from #16493.

Copy link
Author

@sampart sampart Aug 9, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okaydoke, and thanks for the link. Added in commit 84a6d70 now.

@sstok
Copy link
Contributor

sstok commented Aug 8, 2017

no, but this is only a documentation change - I don't think it's my change that has broken them.

Don't worry, this happens from time to time 👍

@sampart
Copy link
Author

sampart commented Aug 9, 2017

Thanks for the reassuring words about tests, @sstok - that sort of reassurance makes contributing easier for us first-timers!

@@ -546,6 +546,95 @@ Security

* The `VoterInterface::supportsClass` and `supportsAttribute` methods were
deprecated and will be removed from the interface in 3.0.

* The the `key` setting of `anonymous`, `remember_me` and `http_digest`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: The the

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 4879eb4

@fabpot
Copy link
Member

fabpot commented Aug 10, 2017

Thank you @sampart.

fabpot added a commit that referenced this pull request Aug 10, 2017
… (sampart)

This PR was squashed before being merged into the 2.8 branch (closes #23826).

Discussion
----------

[2.8] Modify 2.8 upgrade doc - key option is deprecated.

| Q             | A
| ------------- | ---
| Branch?       | 2.8
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | no, but this is only a documentation change - I don't think it's my change that has broken them.
| Fixed tickets | n/a
| License       | MIT
| Doc PR        | n/a

The 2.8.0 section of the [CHANGELOG for the Security bundle](https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/SecurityBundle/CHANGELOG.md#280) has two items in it
> * deprecated the `key` setting of `anonymous`, `remember_me` and `http_digest` in favor of the `secret` setting.
>  * deprecated the `intention` firewall listener setting in favor of the `csrf_token_id`.

The first of these isn't also in the Symfony upgrade guide, but the second is.

This PR adds the missing item (deprecated `key` setting) into the Symfony upgrade guide.

Commits
-------

2309fd9 [2.8] Modify 2.8 upgrade doc - key option is deprecated.
@xabbuh xabbuh closed this Aug 10, 2017
@sampart sampart deleted the 2.8-upgrade-doc-key-deprecated branch August 11, 2017 07:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants