search

moodlehq / moodle-plugin-ci

Helps running Moodle plugins analysis checks and tests under various CI environments.
https://moodlehq.github.io/moodle-plugin-ci/
GNU General Public License v3.0
41 stars 43 forks source link

Create the new major version docs #286

Open stronk7 opened 4 months ago

stronk7 commented 4 months ago

Each time that a new major release comes, there are a bunch of docs to create and/or amend.

As reference, these are changes that we did for v4: https://github.com/moodlehq/moodle-plugin-ci/commit/fcfc276236820d30a69fd45c25348abea55183b4

Also, ensure that all the changes in this milestone (and more) are detailed in the changelog.

ewallah commented 4 months ago

Perhaps the sample scripts could be updated so the latest version is always used:

- composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4
+ composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci
gjb2048 commented 4 months ago

@ewallah But wouldn't that take away control during the migration period between two versions and not allow scheduling of changes to the configuration files?

stronk7 commented 4 months ago

Correct (agree with @gjb2048), it's way better to have the version always specified, and then opt-in into the new one when ready.

Major versions come with incompatible changes:

And that would break near everywhere. So pretty much the opposite, everybody should be, always, specifying the moodle-plugin-ci version to use. IMO.

Ciao :-)