hobbyhimmel/odoo-openupgrade-wizard
8
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'fix-readme' into 'main'

Browse Source 
[FIX] missing shell command and typos in README.md

See merge request odoo-openupgrade-wizard/odoo-openupgrade-wizard!106
This commit is contained in:
Sergio Zanchetta 2025-01-07 20:36:25 +00:00
commit 57f0924713
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -9,7 +9,7 @@
# odoo-openupgrade-wizard # odoo-openupgrade-wizard
Odoo Openupgrade Wizard is a tool that helps developpers to make major Odoo Openupgrade Wizard is a tool that helps developers to make major
upgrade of Odoo Community Edition. (formely OpenERP). upgrade of Odoo Community Edition. (formely OpenERP).
It works with Openupgrade OCA tools. (https://github.com/oca/openupgrade) It works with Openupgrade OCA tools. (https://github.com/oca/openupgrade)
@ -130,7 +130,7 @@ modules.csv
* ``log`` folder will contains all the log of the ``odoo-openupgrade-wizard`` * ``log`` folder will contains all the log of the ``odoo-openupgrade-wizard``
and the logs of the odoo instance that will be executed. and the logs of the odoo instance that will be executed.
* ``filestore`` folder will contains the filestore of the odoo database(s) * ``filestore`` folder will contains the filestore of the odoo database(s).
* ``postgres_data`` folder will be used by postgres docker image to store * ``postgres_data`` folder will be used by postgres docker image to store
database. database.
@ -151,12 +151,12 @@ modules.csv
Repo files are pre-generated. You can update them with your custom settings. Repo files are pre-generated. You can update them with your custom settings.
(custom branches, extra PRs, git shallow options, etc...) (custom branches, extra PRs, git shallow options, etc...)
- ``extra_python_requirements.txt`` enumerates the list of extra python librairies - ``extra_python_requirements.txt`` enumerates the list of extra python libraries
required to run the odoo instance. required to run the odoo instance.
The syntax should respect the ``pip install -r`` command. The syntax should respect the ``pip install -r`` command.
(See : https://pip.pypa.io/en/stable/reference/requirements-file-format/) (See : https://pip.pypa.io/en/stable/reference/requirements-file-format/)
- ``extra_debian_requirements.txt`` enumerates the list of extra system librairies - ``extra_debian_requirements.txt`` enumerates the list of extra system libraries
required to run the odoo instance. required to run the odoo instance.
- ``odoo.conf`` file. Add here extra configuration required for your custom modules. - ``odoo.conf`` file. Add here extra configuration required for your custom modules.
@ -170,7 +170,7 @@ extra repositories, or dependencies...
**Note:** **Note:**
- In your repos.yml, preserve ``openupgrade`` and ``server-tools`` repositories - In your repos.yml, preserve ``openupgrade`` and ``server-tools`` repositories
to have all the features of the librairies available. to have all the features of the libraries available.
- In your repos.yml file, the odoo project should be in ``./src/odoo`` - In your repos.yml file, the odoo project should be in ``./src/odoo``
and the openupgrade project should be in ``./src/openupgrade/`` folder. and the openupgrade project should be in ``./src/openupgrade/`` folder.
@ -181,7 +181,7 @@ extra repositories, or dependencies...
**Prerequites:** init + being in a git repository. (if not, you can simply run ``git init``) **Prerequites:** init + being in a git repository. (if not, you can simply run ``git init``)
if you already have a repos.yml file on github / gitlab, it can be convenient to if you already have a repos.yml file on github / gitlab, it can be convenient to
synchronize the repository, instead of copy past the ``repos.yml`` manually. synchronize the repository, instead of copy paste the ``repos.yml`` manually.
In that case, you can add extra values, in the ``config.yml`` file in the section In that case, you can add extra values, in the ``config.yml`` file in the section
@ -242,7 +242,7 @@ For each module and each version, this command tries to parse the
according ``__manifest__.py`` file (and, if possible the according ``setup.py`` file). according ``__manifest__.py`` file (and, if possible the according ``setup.py`` file).
Finally, it overwrite the requirements.txt files present in each env folder. (python and debian requirements). Finally, it overwrite the requirements.txt files present in each env folder. (python and debian requirements).
For exemple, here is the content of the ``addons_python_requirements.txt`` file, For example, here is the content of the ``addons_python_requirements.txt`` file,
when ``barcodes_generator_abstract`` and ``l10n_fr_siret`` are installed (for V16). when ``barcodes_generator_abstract`` and ``l10n_fr_siret`` are installed (for V16).
``` ```
@ -259,9 +259,13 @@ python-stdnum>=1.18
**Prerequites:** init + get-code **Prerequites:** init + get-code
```shell
odoo-openupgrade-wizard docker-build
```
This will build local docker images that will be used in the following steps. This will build local docker images that will be used in the following steps.
At this end of this step executing the following command should show a docker image per version. At the end of this step executing the following command should show a docker image per version.
```shell ```shell
@ -375,10 +379,10 @@ odoo-openupgrade-wizard generate-module-analysis\
--modules MODULE_LIST --modules MODULE_LIST
``` ```
Realize an analyze between the target version (in parameter via the step argument) Realize an analysis between the target version (in parameter via the step argument)
and the previous version. It will generate analysis_file.txt files present and the previous version. It will generate analysis_file.txt files present
in OpenUpgrade project. in OpenUpgrade project.
You can also use this fonction to analyze differences for custom / OCA modules You can also use this function to analyze differences for custom / OCA modules
between several versions, in case of refactoring. between several versions, in case of refactoring.
<a name="command-estimate-workload"/> <a name="command-estimate-workload"/>
@ -414,7 +418,7 @@ Execute an SQL Request on the target database.
**Optional arguments** **Optional arguments**
* If no ``database`` is provided, default ``postgres`` database will be used. exemple: * If no ``database`` is provided, default ``postgres`` database will be used. example:
```shell ```shell
odoo-openupgrade-wizard psql --command "\l"; odoo-openupgrade-wizard psql --command "\l";
@ -524,7 +528,7 @@ For example, the project path is `/path/to/myproject` (where you run the
**Optional arguments** **Optional arguments**
* To chose the database format use `--database-format`. Format can be * To choose the database format use `--database-format`. Format can be
one of the following: one of the following:
- `p` for plain sql text - `p` for plain sql text
- `c` for custom compressed backup of `pg_dump` - `c` for custom compressed backup of `pg_dump`
@ -533,7 +537,7 @@ For example, the project path is `/path/to/myproject` (where you run the
See also https://www.postgresql.org/docs/current/app-pgdump.html See also https://www.postgresql.org/docs/current/app-pgdump.html
The default database format is `c`. The default database format is `c`.
* To chose the filestore format use `--filestore-format`. Format can be * To choose the filestore format use `--filestore-format`. Format can be
one of the following: one of the following:
- `d` copy of the directory structure - `d` copy of the directory structure
- `t` tar version of the directory structure (not compressed) - `t` tar version of the directory structure (not compressed)