Skip to content
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

Create the new major version docs #286

Open
stronk7 opened this issue Mar 15, 2024 · 3 comments
Open

Create the new major version docs #286

stronk7 opened this issue Mar 15, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation task Some task to complete

Comments

@stronk7
Copy link
Member

stronk7 commented Mar 15, 2024

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

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

@stronk7 stronk7 added task Some task to complete documentation Improvements or additions to documentation labels Mar 15, 2024
@ewallah
Copy link

ewallah commented Mar 16, 2024

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
Copy link
Contributor

gjb2048 commented Mar 16, 2024

@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
Copy link
Member Author

stronk7 commented Mar 16, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation task Some task to complete
Projects
None yet
Development

No branches or pull requests

3 participants