Skip to content

Commit ca2ac4a

Browse files
committed
[IMP] odoo.sh: update builds page
closes #15440 Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
1 parent bc45c84 commit ca2ac4a

File tree

9 files changed

+88
-75
lines changed

9 files changed

+88
-75
lines changed
Lines changed: 87 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,124 +1,137 @@
1-
2-
.. _odoosh-gettingstarted-builds:
3-
41
======
52
Builds
63
======
74

5+
In Odoo.sh, a build is a database loaded by an Odoo server (`odoo/odoo
6+
<https://github.com/odoo/odoo>`_ and `odoo/enterprise <https://github.com/odoo/enterprise>`_)
7+
running on a specific revision of your project repository in a containerized environment. Its
8+
purpose is to test the proper behavior of the server, the database, and the features associated with
9+
that revision.
10+
11+
.. _odoo-sh/builds/overview:
12+
813
Overview
914
========
1015

11-
In Odoo.sh, a build is considered as a database loaded by an Odoo server
12-
(`odoo/odoo <https://github.com/odoo/odoo>`_ & `odoo/enterprise
13-
<https://github.com/odoo/enterprise>`_) running on a specific revision of your project repository in
14-
a containerized environment. Its purpose is to test the well-behavior of the server, the database
15-
and the features with this revision.
16-
17-
.. image:: builds/interface-builds.png
18-
:align: center
16+
.. image:: builds/builds-overview.png
17+
:alt: Overiew of the builds
1918

20-
In this view, a row represents a branch, and a cell of a row represents a build of this branch.
19+
In the :guilabel:`Builds` overview, a row represents a branch, and a cell within that row represents
20+
a build of that branch.
2121

22-
Most of the time, builds are created following pushes on your Github repository branches.
23-
They can be created as well when you do other operations,
24-
such as importing a database on Odoo.sh or asking a rebuild for a branch in your project.
22+
Most builds are created after pushes to your GitHub repository branches. They can also be created
23+
through other operations, such as importing a database on Odoo.sh or requesting a rebuild for a
24+
branch in your project.
2525

26-
A build is considered successful if no errors or warnings come up during its creation.
27-
A successful build is highlighted in green.
26+
Builds can have three possible statuses:
2827

29-
A build is considered failed if errors come up during its creation.
30-
A failed build is highlighted in red.
28+
- A build is considered **successful** if no errors or warnings occur during its creation.
29+
Successful builds are highlighted in **green**.
30+
- A build is considered **almost successful** if warnings occur, but there are no errors. Almost
31+
successful builds are highlighted in **yellow**.
32+
- A build is considered **failed** if errors occur during its creation. Failed builds are
33+
highlighted in **red**.
3134

32-
If warnings come up during the creation, but there are no errors, the build is considered almost
33-
successful. It is highlighted in yellow to notify the developer warnings were raised.
35+
.. note::
36+
Builds do not always create a database from scratch. For instance, when pushing a change on the
37+
production branch, the created build starts the server with your new revision and tries to load
38+
the current production database on it.
3439

35-
Builds do not always create a database from scratch. For instance, when pushing a change on the
36-
production branch, the build created just starts the server with your new revision and tries to load
37-
the current production database on it. If no errors come up, the build is considered successful, and
38-
otherwise failed.
40+
.. _odoo-sh/builds/stages:
3941

4042
Stages
4143
======
4244

45+
.. _odoo-sh/builds/stages/production:
46+
4347
Production
4448
----------
4549

46-
The first build of a production branch creates a database from scratch.
47-
If this build is successful, this database is considered as the production database of your project.
50+
The first build of a production branch creates a database from scratch. If this build is successful,
51+
this database will become the production database of your project.
52+
53+
From then on, pushes to the production branch will create new builds that attempt to load the
54+
database using a server running the new revision.
4855

49-
From then, pushes on the production branch will create new builds that attempt to load the database
50-
using a server running with the new revision.
56+
If the build is successful or almost successful, the production database will run with this build
57+
and its associated revision.
5158

52-
If the build is successful, or has warnings but no errors, the production database will now run with
53-
this build, along with the revision associated to this build.
59+
If the build fails to load or update the database, the previous successful build is reused to load
60+
the database. In that case, the database continues to run using the previous successful revision.
5461

55-
If the build fails to load or update the database, then the previous successful build is re-used to
56-
load the database, and therefore the database will run using a server running with the previous
57-
successful revision.
62+
.. note::
63+
The build used to run the production database is always the first in the builds list. If a build
64+
fails, it is placed after the build currently running the production database.
5865

59-
The build used to run the production database is always the first of the builds list. If a build
60-
fails, it is put after the build currently running the production database.
66+
.. _odoo-sh/builds/stages/staging:
6167

6268
Staging
6369
-------
6470

65-
Staging builds duplicate the production database,
66-
and try to load this duplicate with the revisions of the staging branches.
71+
Staging builds duplicate the production database and attempt to load this copy using the revisions
72+
of the staging branches.
6773

68-
Each time you push a new revision on a staging branch, the build created uses a new copy of the
69-
production database. The databases are not re-used between builds of the same branch. This ensures:
74+
Each time you push a new revision to a staging branch, the resulting build uses a fresh copy of the
75+
production database. Databases are not reused between builds of the same branch. This ensures that:
7076

71-
* staging builds use databases that are close to what the production looks like, so you do not make
72-
your tests with outdated data,
77+
- Staging builds use databases that closely match the current production state, so your tests are
78+
not performed on outdated data.
79+
- You can freely experiment within a staging database. When you want to start over with a new copy
80+
of the production database, you can request a rebuild.
7381

74-
* you can play around as much as you want in the same staging database, and you can then ask for a
75-
rebuild when you want to restart with a new copy of the production.
82+
However, this also means that if you make configuration changes in a staging database and do not
83+
apply them in production, those changes will not be present in the next build of the same staging
84+
branch.
7685

77-
Nevertheless, this means that if you make configuration changes in staging databases and do not
78-
apply them in the production, they will not be passed on the next build of the same staging branch.
86+
.. _odoo-sh/builds/stages/development:
7987

8088
Development
8189
-----------
8290

83-
Development builds create new databases, load the demo data and run the unit tests.
91+
Development builds create new databases, load the demo data, and run the unit tests.
8492

85-
A build will be considered failed and highlighted in red if tests fail during the installation,
86-
as they are meant to raise errors if something wrong occurs.
93+
A build will be considered failed if tests fail during installation, as they are designed to raise
94+
errors when something is wrong.
8795

88-
If all tests pass, and there is no error, the build will be considered successful.
96+
If all tests pass and no errors occur, the build is considered successful.
8997

90-
According to the list of modules to install and test, a development build can take up to 1 hour to
91-
be ready. This is due to the large number of tests set in the default Odoo modules suite.
98+
.. note::
99+
Depending on the list of modules to install and test, a development build can take up to one hour
100+
to be ready. This is due to the large number of tests included in the default Odoo module suite.
101+
102+
.. _odoo-sh/builds/stages/features:
92103

93104
Features
94105
========
95106

96-
The production branch will always appear first, and then the other branches are ordered by last
97-
build created. You can filter out the branches.
98-
99-
.. image:: builds/interface-builds-branches.png
100-
:align: center
107+
The production branch always appears first. Other branches are ordered by the time of their last
108+
created build. The stage highlighted in purple corresponds to the stage selected in the
109+
:guilabel:`Branches` menu.
101110

102-
For each branch, you can access the last build's database using the *Connect* link and jump to the
103-
branch code using the *Github* link. For other branches than the production, you can create a new
104-
build which will use the latest revision of the branch using the link *rebuild*. This last link is
105-
not available when there is already a build in progress for the branch.
111+
.. tip::
112+
You can filter branches using the search bar.
106113

107-
.. image:: builds/interface-builds-build.png
108-
:align: center
114+
.. image:: builds/branches-menu.png
115+
:alt: The branches menu
109116

110-
For each build, you can access the revision changes using the button with the Github icon. You can
111-
access the build's database as the administrator using the *Connect* button. Also, you can access
112-
the database with another user using the *Connect as* button, in the dropdown menu of the *Connect*
113-
button.
117+
For each branch, you can:
114118

115-
.. _odoosh-gettingstarted-builds-download-dump:
119+
- Access the latest build's database by clicking :guilabel:`Connect`.
120+
- Jump to the branch's code by clicking :guilabel:`Github`.
121+
- Create a new build by clicking :guilabel:`Rebuild`. It uses the latest revision of the branch (it
122+
is not available if a build is already in progress for that branch).
116123

117-
.. image:: builds/interface-builds-build-dropdown.png
118-
:align: center
124+
For each build, you can:
119125

120-
.. _odoosh-gettingstarted-builds-dropdown-menu:
126+
- View the revision changes by clicking the :icon:`fa-github` (:guilabel:`GitHub`) icon.
127+
- Access the build's database as the administrator by clicking :guilabel:`Connect` or as another
128+
user by clicking the :icon:`fa-caret-down` (:guilabel:`More Actions`) button next to
129+
:guilabel:`Connect` and selecting :guilabel:`Connect as`.
130+
- Access the same tools as in the branches view by clicking the :icon:`fa-caret-down`
131+
(:guilabel:`More Actions`) button next to :guilabel:`Connect` and selecting :guilabel:`Logs`,
132+
:guilabel:`Web Shell`, :guilabel:`Editor`, :guilabel:`Outgoing e-mails` (for the staging and
133+
development stages), :guilabel:`Monitoring`, and :guilabel:`Download DB dump` (for the production
134+
and staging stages).
121135

122-
In the dropdown menu of the build, you can access the same features than in :ref:`the branches view
123-
<odoo-sh/branches/tabs>`: *Logs*, *Web Shell*, *Editor*, *Outgoing e-mails*. You also
124-
have the possibility to *Download a dump* of the build's database.
136+
.. image:: builds/builds-options.png
137+
:alt: A build's options
6.31 KB
Loading
4.16 KB
Loading
32 KB
Loading
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

content/administration/odoo_sh/getting_started/online-editor.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ It also gives you the possibility to open terminals, Python consoles, Odoo Shell
1717

1818
You can access the editor of a build through
1919
:ref:`the branches tabs <odoo-sh/branches/tabs>`,
20-
:ref:`the builds dropdown menu <odoosh-gettingstarted-builds-dropdown-menu>`
20+
:ref:`the builds dropdown menu <odoo-sh/builds/stages/features>`
2121
or by adding */odoo-sh/editor* to your build domain name
2222
(e.g. *https://odoo-addons-master-1.dev.odoo.com/odoo-sh/editor*).
2323

0 commit comments

Comments
 (0)