Skip to content

docs: add how to use next minor version branch #7838

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

Merged
merged 1 commit into from
Aug 21, 2023
Merged
Changes from all 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
36 changes: 31 additions & 5 deletions user_guide_src/source/installation/installing_composer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,23 +114,49 @@ The `development user guide <https://codeigniter4.github.io/CodeIgniter4/>`_ is
Note that this differs from the released user guide, and will pertain to the
develop branch explicitly.

Update for Latest Dev
^^^^^^^^^^^^^^^^^^^^^

In your project root:

.. code-block:: console

php builds development

The command above will update **composer.json** to point to the ``develop`` branch of the
working repository, and update the corresponding paths in config and XML files. To revert
these changes run:
working repository, and update the corresponding paths in config and XML files.

After using the ``builds`` command be sure to run ``composer update`` to sync your vendor
folder with the latest target build. Then, check the :doc:`upgrading` and update project
files if necessary.

Next Minor Version
^^^^^^^^^^^^^^^^^^

If you want to use the next minor version branch, after using the ``builds`` command
edit **composer.json** manually.

If you try the ``4.4`` branch, change the version to ``4.4.x-dev``::

"require": {
"php": "^7.4 || ^8.0",
"codeigniter4/codeigniter4": "4.4.x-dev"
},

And run ``composer update`` to sync your vendor
folder with the latest target build. Then, check the Upgrading Guide
(**user_guide_src/source/installation/upgrade_{version}.rst**) and
update project files if necessary.

Revert to Stable Release
^^^^^^^^^^^^^^^^^^^^^^^^

To revert the changes run:

.. code-block:: console

php builds release

After using the ``builds`` command be sure to run ``composer update`` to sync your vendor
folder with the latest target build.

Adding CodeIgniter4 to an Existing Project
==========================================

Expand Down