You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+15-15
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
[](https://github.com/m3r3nix/odoo-dev-container/actions/workflows/docker-publish.yml)
1
+
[](https://github.com/m3r3nix/odoo-dev-container/actions/workflows/docker-publish.yml)
2
2
3
-
# Odoo Development Container for GitHub Codespaces
3
+
# Odoo Development Container for GitHub Codespaces and Visual Studio Code on Desktop
4
4
5
-
You can spin up a development-ready environment in just 4 simple steps:
5
+
Spin up a development-ready environment in just 4 simple steps:
6
6
1. Fork this repository or use it as a template and make it private (particularly if you intend to work with the Enterprise Edition).
7
7
Ensure that during this process, all branches are copied, not just the default one, if you aim to work with older Odoo versions as well.
8
8
2. Go to GitHub Actions and wait for all build processes to complete successfully. (Should you encounter any issues, please refer to the `Troubleshooting` section.)
9
-
3. Select the branch corresponding to the Odoo version you wish to develop for and initiate a Codespace. (First boot takes about 2 mins.)
9
+
3. Select the branch corresponding to the Odoo version you wish to develop for and initiate a Codespace. (The first boot takes about 2 minutes, be patient)
10
10
NOTE: If your work involves the Enterprise Edition, please adhere to the instructions in `Create/Update an Enterprise based image`.
11
11
4. Within the new VS Code instance, select the `Ports` tab. Then, right-click on port `8069` and choose `Open in Browser`. It will launch your new Odoo instance in your web browser.
12
12
@@ -15,39 +15,39 @@ You can spin up a development-ready environment in just 4 simple steps:
15
15
- Your custom addons must be located in the `/custom` directory of the repository. However, within the Codespaces VS Code editor, this directory will serve as your root folder. See `estate-demo-addon`.
16
16
- The build action is triggered by any change to the `.devcontainer/URL.conf` file. However, if you already have the latest Community URL in place and simply need a new build based on the most recent `latest_all.deb` package, you can go to GitHub Actions and trigger the action manually.
17
17
- After forking this repository, update the GitHub Actions Badge URL at the top of the `README.md` file to reflect your own build processes. Otherwise, it will always display `no status`.
18
-
- Images are tagged not only with `latest` but also with the version number of the downloaded Debian Odoo installer package. This approach allows you to spin up a Codespace with a previous build version in case the latest Odoo version has a serious bug. Simply select an image, for example, `odoo-v17-community`, and look for available tags like `17.0.20240202` in your Container Registry. Then, adjust the tag in `docker-compose.yml` accordingly.
18
+
- Images are tagged not only with `latest` but also with the version number of the downloaded Debian Odoo installer package. This approach allows you to spin up a Codespace with a previous build version in case the latest Odoo version has a serious bug. Simply select an image, for example, `odoo-v18-community`, and look for available tags like `18.0.20240202` in your Container Registry. Then, adjust the tag in `docker-compose.yml` accordingly.
19
19
20
20
## How to create/update the development Docker image?
21
21
22
22
### Create/Update a Community based image
23
23
24
24
1. Update the current URL in `.devcontainer/URL.conf` to the latest Community version:
Alternatively, select a specific build date from the following link and insert its corresponding URL into the file:
27
-
<https://nightly.odoo.com/17.0/nightly/deb>
28
-
2. If required, update the image name/tag in the `docker-compose.yml` file accordingly, for example `odoo-v17-community:latest`.
27
+
<https://nightly.odoo.com/18.0/nightly/deb>
28
+
2. If required, update the image name/tag in the `docker-compose.yml` file accordingly, for example `odoo-v18-community:latest`.
29
29
3. Commit and push your changes. This will automatically trigger a new build for the Docker image in GitHub Actions.
30
30
4. Look for any errors in the build process. If it's green, then we are fine, you can open a Codespace.
31
31
32
32
### Create/Update an Enterprise based image
33
33
34
34
1. Obtain the download link for the latest Odoo Enterprise Debian installation package:
35
35
<https://www.odoo.com/page/download>
36
-
After providing your Odoo Enterprise subscription code, a new page will appear.
36
+
After filling the form, click on Download (Ubuntu/Debian) and a "Congratulations! The download is starting" page will appear.
37
37
Right-click on `Click here` and select `Copy link` from your browser's dropdown menu.
38
38
This will give you a temporary download link, valid for approximately 30 minutes.
39
39
2. Replace the URL in `.devcontainer/URL.conf` with the new one you have copied to the clipboard.
40
-
3. If required, update the image name/tag in the `docker-compose.yml` file accordingly, for example `odoo-v17-enterprise:latest`.
40
+
3. If required, update the image name/tag in the `docker-compose.yml` file accordingly, for example `odoo-v18-enterprise:latest`.
41
41
4. Commit and push your changes. This will automatically trigger a new build for the Docker image in GitHub Actions.
42
42
5. Look for any errors in the build process. If it's green, then we are fine, you can open a Codespace.
43
43
44
44
## In case of a new Odoo main release
45
45
46
-
1. The default branch should always contain the latest version. Therefore, create a new branch named after the latest version (e.g., `v18`) before making any changes.
46
+
1. The default branch should always contain the latest version. Therefore, create a new branch named after the latest version (e.g., `v19`) before making any changes.
47
47
2. Update the `Dockerfile` to reflect the current version from the official repository: <https://github.com/odoo/docker>
48
48
3. Attempt to build it and check for any errors.
49
49
4. Change the image tag in `docker-compose.yml` if necessary.
50
-
5. Update demo addon version number
50
+
5. Update demo addon version number in manifest.py
51
51
6. Update README.md
52
52
53
53
## Possible improvements
@@ -65,11 +65,11 @@ You can create a pre-built Codespace template to speed up the initial boot proce
65
65
## Troubleshooting
66
66
67
67
- Forking the repository initiates a build process for all available Odoo versions simultaneously. Due to these parallel builds, the GitHub Container Registry might face permission limitations. If this occurs, wait until all builds are complete. Then, identify any failed build and select `Re-run failed job`.
68
-
- If you're forking or using this repository as a template more than once, you may encounter a permission issue during the docker image push process. This typically happens because an image with the same name (e.g. `odoo-v17-community`) already exists in your Container Registry, created by a different repository, which means the new repository lacks rights to update the image.
69
-
`Error: buildx failed with: ERROR: failed to solve: failed to push ghcr.io/YOURNAME/odoo-v17-community:17.0.20240202: unexpected status from POST request to https://ghcr.io/v2/YOURNAME/odoo-v17-community/blobs/uploads/: 403 Forbidden`
68
+
- If you're forking or using this repository as a template more than once, you may encounter a permission issue during the docker image push process. This typically happens because an image with the same name (e.g. `odoo-v18-community`) already exists in your Container Registry, created by a different repository, which means the new repository lacks rights to update the image.
69
+
`Error: buildx failed with: ERROR: failed to solve: failed to push ghcr.io/YOURNAME/odoo-v18-community:18.0.20240202: unexpected status from POST request to https://ghcr.io/v2/YOURNAME/odoo-v18-community/blobs/uploads/: 403 Forbidden`
70
70
To resolve this issue:
71
71
- Navigate to `Packages` and remove the search filter to display all available images in your Container Registry.
72
-
- Select `odoo-v17-community`, proceed to `Package settings`, and under `Manage Actions access`, add your current repository with write access.
72
+
- Select `odoo-v18-community`, proceed to `Package settings`, and under `Manage Actions access`, add your current repository with write access.
0 commit comments