[ADD] documentation
This commit is contained in:
Sylvain LE GAL
parent
2a0b46ca60
commit
38dbe1e719
8
CONTRIBUTORS.md
Normal file
8
CONTRIBUTORS.md
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
# Developers
|
||||
|
||||
* Sylvain LE GAL from GRAP (http://www.grap.coop)
|
||||
|
||||
# Reviewers
|
||||
|
||||
* Sébastien BEAU, from Akretion (https://akretion.com)
|
||||
* Rémy TAYMANS, from Coop It Easy (https://coopiteasy.be/)
|
||||
40
INTERNAL_NOTES.md
Normal file
40
INTERNAL_NOTES.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# TODO
|
||||
|
||||
* with coop it easy :
|
||||
- short_help of group decorator ? seems useless...
|
||||
|
||||
* add constrains on ``--step`` option.
|
||||
|
||||
* revert : set 777 to log and filestore to be able to write on this folder
|
||||
inside the containers. TODO, ask to coop it easy or commown for better alternative.
|
||||
|
||||
* allow to call odoo-bin shell, via : https://github.com/d11wtq/dockerpty
|
||||
(see https://github.com/docker/docker-py/issues/247)
|
||||
|
||||
|
||||
# List of the series of odoo
|
||||
# python version is defined, based on the OCA CI.
|
||||
# https://github.com/OCA/oca-addons-repo-template/blob/master/src/.github/workflows/%7B%25%20if%20ci%20%3D%3D%20'GitHub'%20%25%7Dtest.yml%7B%25%20endif%20%25%7D.jinja
|
||||
|
||||
|
||||
# tips
|
||||
```
|
||||
# execute sql request in postgres docker
|
||||
docker exec db psql --username=odoo --dbname=test_v12 -c "update res_partner set ""email"" = 'bib@bqsdfqsdf.txt';"
|
||||
```
|
||||
|
||||
# TODO Nice To have
|
||||
|
||||
- Fix gitlabci-local. For the time being, it is not possible to debug
|
||||
locally. (there are extra bugs locally that doesn't occures on gitlab,
|
||||
in ``cli_B_03_run_test.py``...
|
||||
|
||||
|
||||
|
||||
# Try gitlab runner
|
||||
|
||||
curl -LJO "https://gitlab-runner-downloads.s3.amazonaws.com/latest/deb/gitlab-runner_amd64.deb"
|
||||
|
||||
sudo dpkg -i gitlab-runner_amd64.deb
|
||||
|
||||
(https://docs.gitlab.com/runner/install/linux-manually.html)
|
||||
|
|
@ -19,11 +19,14 @@ this tool is useful for complex migrations:
|
|||
It will create a migration environment (with all the code available)
|
||||
and provides helpers to run (and replay) migrations until it works.
|
||||
|
||||
* To develop and contribute to the library, refer to the ``DEVELOP.md`` file.
|
||||
* Refer to the ``ROADMAP.md`` file to see the current limitation, bugs, and task to do.
|
||||
* See authors in the ``CONTRIBUTORS.md`` file.
|
||||
|
||||
# Installation
|
||||
|
||||
``pipx install odoo-openupgrade-wizard``.
|
||||
|
||||
To develop and contribute to the library, refer to the ``DEVELOP.md`` file.
|
||||
|
||||
# Usage
|
||||
|
||||
|
|
|
|||
82
ROADMAP.md
82
ROADMAP.md
|
|
@ -1,79 +1,45 @@
|
|||
# TODO
|
||||
# Python Version
|
||||
|
||||
* with coop it easy :
|
||||
- short_help of group decorator ? seems useless...
|
||||
|
||||
* add constrains on ``--step`` option.
|
||||
|
||||
|
||||
* revert : set 777 to log and filestore to be able to write on this folder
|
||||
inside the containers. TODO, ask to coop it easy or commown for better alternative.
|
||||
|
||||
* allow to call odoo-bin shell, via : https://github.com/d11wtq/dockerpty
|
||||
(see https://github.com/docker/docker-py/issues/247)
|
||||
* py310 is not available, due to dependencies to ``odoorpc`` that raise an error :
|
||||
``ERROR tests/cli_A_init_test.py - AttributeError: module 'collections' has no attribute 'MutableMapping'``
|
||||
Follow bug : https://stackoverflow.com/questions/69512672/getting-attributeerror-module-collections-has-no-attribute-mutablemapping-w
|
||||
|
||||
# openUpgradelib Versions
|
||||
|
||||
* ``openupgradelib`` requires a new feature psycopg2.sql since
|
||||
(21 Aug 2019)
|
||||
https://github.com/OCA/openupgradelib/commit/7408580e4469ba4b0cabb923da7facd71567a2fb
|
||||
so we pin openupgradelib==2.0.0 (21 Jul 2018)
|
||||
|
||||
|
||||
V12 : Python 3.5.3 (default, Apr 5 2021, 09:00:41)
|
||||
|
||||
```
|
||||
# See : https://github.com/OCA/openupgradelib/issues/248
|
||||
# https://github.com/OCA/openupgradelib/issues/288
|
||||
_LEGACY_OPENUPGRADELIB = (
|
||||
"git+https://github.com/OCA/openupgradelib.git"
|
||||
"@ed01555b8ae20f66b3af178c8ecaf6edd110ce75#egg=openupgradelib"
|
||||
)
|
||||
|
||||
# List of the series of odoo
|
||||
# python version is defined, based on the OCA CI.
|
||||
# https://github.com/OCA/oca-addons-repo-template/blob/master/src/.github/workflows/%7B%25%20if%20ci%20%3D%3D%20'GitHub'%20%25%7Dtest.yml%7B%25%20endif%20%25%7D.jinja
|
||||
|
||||
```
|
||||
|
||||
* py310 is not available, due to dependencies to ``odoorpc`` that raise an error :
|
||||
``ERROR tests/cli_A_init_test.py - AttributeError: module 'collections' has no attribute 'MutableMapping'``
|
||||
The python version in the Odoo:12 docker image is : ``Python 3.5.3 (default, Apr 5 2021, 09:00:41)`` that is very old.
|
||||
|
||||
|
||||
# tips
|
||||
```
|
||||
# execute sql request in postgres docker
|
||||
docker exec db psql --username=odoo --dbname=test_v12 -c "update res_partner set ""email"" = 'bib@bqsdfqsdf.txt';"
|
||||
```
|
||||
- https://github.com/OCA/openupgradelib/issues/248
|
||||
- https://github.com/OCA/openupgradelib/issues/288
|
||||
- https://github.com/OCA/openupgradelib.git@ed01555b8ae20f66b3af178c8ecaf6edd110ce75#egg=openupgradelib
|
||||
|
||||
TODO : Fix via another way (other way than pining ``openuppgradelib`` version) the problem of old odoo versions. (it makes the upgrade failing for old revision (V8, etc...))
|
||||
|
||||
# TODO Must Have
|
||||
# Gitlab-CI
|
||||
|
||||
- Fix via another way the problem of old ``openupgradelib``.
|
||||
(it makes the upgrade failing for old revision (V8, etc...))
|
||||
* for the time being, Features requiring ``odoorpc`` are failing in gitlab-CI.
|
||||
Tests are working locally but there is a network problem. For that reason, tests witch names
|
||||
begins by ``cli_2`` like (``cli_20_install_from_csv_test.py``) are disabled in ``.gitlab-ci.yml``.
|
||||
|
||||
- Fix gitlab CI. tests are working locally but there is a network problem
|
||||
to use ``odoorpc`` on gitlab-ci.
|
||||
TODO : work with Pierrick Brun, to run gitlab-runner on Akretion CI (without docker), to see if it is
|
||||
fixing the problem.
|
||||
|
||||
# TODO Features
|
||||
# Features Work In Progress
|
||||
|
||||
- select ``without-demo all`` depending on if the database
|
||||
is created or not (, and if current database contains demo data ?!?)
|
||||
* Add a tools to analyze workload.
|
||||
|
||||
- add a tools to analyze workload.
|
||||
# Possible Improvments
|
||||
|
||||
# TODO Nice To have
|
||||
* select ``without-demo all`` depending on if the database
|
||||
is created or not (and if current database contains demo data, checking if base.user_demo exists ?)
|
||||
|
||||
- Fix gitlabci-local. For the time being, it is not possible to debug
|
||||
locally. (there are extra bugs locally that doesn't occures on gitlab,
|
||||
in ``cli_B_03_run_test.py``...
|
||||
# Other points not in the scope of GRAP work
|
||||
|
||||
- Check if there are default values for containers, limiting ressources.
|
||||
* Allow to use custom docker images.
|
||||
|
||||
|
||||
# Try gitlab runner
|
||||
|
||||
curl -LJO "https://gitlab-runner-downloads.s3.amazonaws.com/latest/deb/gitlab-runner_amd64.deb"
|
||||
|
||||
sudo dpkg -i gitlab-runner_amd64.deb
|
||||
|
||||
(https://docs.gitlab.com/runner/install/linux-manually.html)
|
||||
* Check if there are default values for containers, limiting ressources.
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user