feature: Adopt a release & PHP / dependency version support policy #173
Conversation
|
The RTD webhook is now working :) rendered version of the new page available to preview at https://behat--173.org.readthedocs.build/en/173/releases.html |
releases.rst
Outdated
| Major Released Bugfix EOL Security EOL | ||
| ======= ========== ============ ============ ===================================================================== | ||
| `v2.x`_ July 2011 June 2015 June 2015 `Changelog <https://github.com/Behat/Behat/blob/2.5/CHANGES.md>`__ | ||
| `v3.x`_ April 2014 *>12 months* *>24 months* `Changelog <https://github.com/Behat/Behat/blob/master/CHANGES.md>`__ |
There was a problem hiding this comment.
This may be a bit confusing, some users may read this as "bugfixes ended 12 months after April 2014 and security fixes ended 24 months after April 2014"? Maybe adopt what other tools do which to show which versions are maintained, which are security fixes only, which are end of life and even show future unreleased versions. So we could list version 2.x as end of life for bugs and security, 3.x as maintained and 4.x as unreleased. What do you think?
There was a problem hiding this comment.
@carlos-granados thanks for the review, and yes, I wondered if that would be clear enough to a new reader.
I've reworked the structure of the page to separate out the current from unmaintained versions, I think it's easier to follow now, let me know what you think.
I haven't listed 4.x yet as I don't think there's actually anything really on it yet, and it is out of date with 3.x. We can add it when we start working on it properly.
Great 🎉 Can we somehow generate this link automatically somewhere when we create a PR? |
|
@carlos-granados it is actually available in the GitHub UI of the PR. That's the URL for the |
acoulton
force-pushed
the
support-policy
branch
from
a008a5a to
ac42d4e
Compare
releases.rst
Outdated
| ======= ========== ========== ============ ===================================================================== | ||
| Major Released Bugfix EOL Security EOL | ||
| ======= ========== ========== ============ ===================================================================== | ||
| `v3.x`_ April 2014 See below See below `Changelog <https://github.com/Behat/Behat/blob/master/CHANGES.md>`__ |
There was a problem hiding this comment.
Should be https://github.com/Behat/Behat/blob/master/CHANGELOG.md
releases.rst
Outdated
| Support for PHP and dependency versions | ||
| --------------------------------------- | ||
|
|
||
| Behat only supports current versions of PHP and third-party dependency packages (e.g. symfony components). |
There was a problem hiding this comment.
I would probably use Symfony (with uppercase S) everywhere
|
BTW, love that now a version is built for each PR, this makes it much easier to review proposals |
Co-authored-by: Christophe Coevoet <[email protected]>
acoulton
force-pushed
the
support-policy
branch
from
9650514 to
396c394
Compare
Yeah, I had a feeling that was going to be super helpful |
For discussion as much as anything else...
Following the discussion / agreement in Behat/Behat#1503 I have drafted a docs page outlining our policy on supporting PHP and symfony versions.
I think we should also have a public policy on support for Behat versions themselves, so I have proposed one here. I think we should give users a sense of what to expect (to give them confidence to choose Behat, as much as anything) but I think we also need to be realistic about our maintainer / community resources. Therefore I think the rolling support life I've suggested makes more sense than committing to e.g. a fixed schedule for releasing and dropping major versions.
My suggestion is that this should live as a page in the docs, and then we'd also link to it from the Behat/Behat README and potentially the top of the CHANGELOG too.
Questions, challenges, and alternate opinions are very welcome!