moodle-plugin-ci icon indicating copy to clipboard operation
moodle-plugin-ci copied to clipboard

Published 20 hours ago • verified publisher icon moodlehq

Create the new major version docs

Open stronk7 opened this issue 11 months ago • 3 comments

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.

stronk7 avatar Mar 15 '24 18:03 stronk7

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

ewallah avatar Mar 16 '24 09:03 ewallah

@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?

gjb2048 avatar Mar 16 '24 11:03 gjb2048

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:

  • PHP requirements.
  • Moodle requirements.
  • Removed commands.
  • ...

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 :-)

stronk7 avatar Mar 16 '24 11:03 stronk7