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

docs: add "Upgrading to a Specified Version" #8759

Merged
merged 6 commits into from
Apr 13, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 71 additions & 2 deletions user_guide_src/source/installation/installing_composer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,35 @@ If you omit the "project-root" argument, the command will create an
that are not needed in the production environment. This will greatly reduce
the vendor folder size.

Installing Previous Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For example, you may want to install v4.4.8 after v4.5.0 has been released.

In that case, specify the version in the command:

.. code-block:: console

composer create-project codeigniter4/appstarter:4.4.8 project-root

Then, open **composer.json** in your project root folder, and specify
the framework version:

.. code-block:: text

"require": {
...
"codeigniter4/framework": "4.4.8"
},

Then, run the ``composer update`` command.

.. note:: If you fix the version number like ``"codeigniter4/framework": "4.4.8"``
kenjis marked this conversation as resolved.
Show resolved Hide resolved
in your **composer.json**, ``composer update`` command will not update the
kenjis marked this conversation as resolved.
Show resolved Hide resolved
framework. See `Writing Version Constraints`_ for how to specify the version.
kenjis marked this conversation as resolved.
Show resolved Hide resolved

.. _Writing Version Constraints: https://getcomposer.org/doc/articles/versions.md#writing-version-constraints

Initial Configuration
---------------------

Expand All @@ -82,7 +111,29 @@ Whenever there is a new release, then from the command line in your project root

composer update

Read the :doc:`upgrade instructions <upgrading>`, and check Breaking Changes and Enhancements.
Read the :doc:`upgrade instructions <upgrading>` and :doc:`change log <../changelogs/index>`,
and check Breaking Changes and Enhancements.

Upgrading to a Specified Version
kenjis marked this conversation as resolved.
Show resolved Hide resolved
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For example, you may want to upgrade from v4.4.7 to v4.4.8 after v4.5.0 has been released.

In that case, open **composer.json** in your project root folder, and specify
the framework version:

.. code-block:: text

"require": {
...
"codeigniter4/framework": "4.4.8"
},

Then, run the ``composer update`` command.

.. note:: If you fix the version number like ``"codeigniter4/framework": "4.4.8"``
kenjis marked this conversation as resolved.
Show resolved Hide resolved
in your **composer.json**, ``composer update`` command will not update the
kenjis marked this conversation as resolved.
Show resolved Hide resolved
framework. See `Writing Version Constraints`_ for how to specify the version.
kenjis marked this conversation as resolved.
Show resolved Hide resolved

Pros
----
Expand Down Expand Up @@ -215,7 +266,25 @@ Whenever there is a new release, then from the command line in your project root

composer update

Read the :doc:`upgrade instructions <upgrading>`, and check Breaking Changes and Enhancements.
Read the :doc:`upgrade instructions <upgrading>` and :doc:`change log <../changelogs/index>`,
and check Breaking Changes and Enhancements.

Upgrading to a Specified Version
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For example, you may want to upgrade to v4.4.8 after v4.5.0 has been released.
kenjis marked this conversation as resolved.
Show resolved Hide resolved

In that case, open **composer.json** in your project root folder, and specify
the framework version:

.. code-block:: text

"require": {
...
"codeigniter4/framework": "4.4.8"
},

Then, run the ``composer update`` command.

Pros
----
Expand Down
3 changes: 2 additions & 1 deletion user_guide_src/source/installation/installing_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ Upgrading

Download a new copy of the framework, and then replace the **system** folder.

Read the :doc:`upgrade instructions <upgrading>`, and check Breaking Changes and Enhancements.
Read the :doc:`upgrade instructions <upgrading>` and :doc:`change log <../changelogs/index>`,
and check Breaking Changes and Enhancements.

Pros
====
Expand Down