-
Notifications
You must be signed in to change notification settings - Fork 23
chore: add upgrade file doc #224
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
base: 1.x
Are you sure you want to change the base?
Conversation
|
Hello @94noni . You are absolutely right we should have added this file. Although there are several lines to add from v1.0.0...v1.1.0 just a few that comes to mind :
Would you create this file or do you prefer we update this PR ? |
|
i do prefer you take over on this PR if possible (more knowledge of the internal) ;) |
Jean-Beru
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch!
|
Sorry, I didn't see your message before posting.
If so, updating this file must be mandatory for each PR that: adds a feature, deprecations, BC breaks, etc. (everything except doc and bugfix) |
|
@Jean-Beru : taking over this PR right now. I'll complete the upgrade-1.1 + create the upgrade-1.2 and update the Contributing guide as well. |
| * Create a new branch for your changes. | ||
| * Ensure your code follows the existing style and includes tests if applicable. | ||
| * Submit a pull request with a clear description of your changes. | ||
| * Update the correct `UPGRADE-*.md` file if it introduce new deprecations, BC breaks or anything that may require changes on developers side. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * Update the correct `UPGRADE-*.md` file if it introduce new deprecations, BC breaks or anything that may require changes on developers side. | |
| * Update the correct `UPGRADE-*.md` file if it introduces new deprecations, BC breaks or anything that may require changes on developers side. |
| # UPGRADE FROM 1.0.0 to 1.1.0 | ||
|
|
||
| ## Configuration Changes | ||
| * Added new `sensiolabs_gotenberg.version` to add warning if trying to use a non-yet available feature from Gotenberg. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * Added new `sensiolabs_gotenberg.version` to add warning if trying to use a non-yet available feature from Gotenberg. | |
| * Added new `sensiolabs_gotenberg.version` to add warning when trying to use a feature not yet available in Gotenberg. |
Description
i propose to add somewhere a doc for this "feature"
friendly ping @Neirda24 do you think it is worth it ? in this file or directly in the readme ?