Script to generate a development Dockerfile from the deployv image of a repository (based on its variables.sh file)
Free software: BSD license
Installation
pip install travis2docker
Usage
travisfile2dockerfile REPO_URL BRANCH
- Or with pull request
travisfile2dockerfile REPO_URL pull/##
In REPO_URL use the ssh or https url of the git repository. For private repositories use the ssh url.
- For more information execute:
travisfile2dockerfile –help
- Example:
travisfile2dockerfile –root-path=$HOME/t2d git@github.com:Vauxoo/forecast.git 8.0
- The output is:
${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0
- To build image:
${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/10-build.sh
- To create container:
${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/20-run.sh –entrypoint=bash
The repository needs a variables.sh file in its root path (the one used by the deployv images built from the CI). By default the docker image is built from its values as DOCKER_IMAGE_REPO:MAIN_APP-VERSION-SHA_SHORT; use --docker-image=quay.io/vauxoo/PROJECT:TAG to pick the image pushed by the build_docker pipeline instead.
Optional build steps (--build-env-args)
Some development tools and build steps are not enabled by default. They are enabled with a flag passed as a build environment variable using --build-env-args, which generates an ENV <FLAG>=TRUE line in the Dockerfile. If the flag is not defined, the step is skipped.
Flag |
Enables |
|---|---|
VIM_INSTALL |
vim + spf13-vim, vim-openerp, jedi-vim, wakatime and the pylint_odoo/eslint syntastic configuration |
ZSH_INSTALL |
zsh + oh-my-zsh with the odoo-shippable theme |
CHOWN_UID_GID |
Aligns the odoo user UID/GID to 5410 to match OrchestSH images. Slow: it re-chowns the whole filesystem |
Example enabling more than one:
travisfile2dockerfile --build-env-args VIM_INSTALL ZSH_INSTALL \
git@github.com:Vauxoo/forecast.git 8.0
VS Code support (DEPLOYV_VSCODE)
Opt-in with the environment variable DEPLOYV_VSCODE=1:
DEPLOYV_VSCODE=1 travisfile2dockerfile git@github.com:Vauxoo/forecast.git 8.0
It is disabled by default so vim/terminal users do not pay the extra build time. When enabled:
The Dockerfile pre-installs the VS Code server and the extensions listed in templates/.vscode/extensions.json at build time, so attaching VS Code to the container does not download anything live. The server version is pinned to the commit of your local code binary when available (run travisfile2dockerfile again after upgrading VS Code to re-pin it); otherwise the latest stable server is used. If the pinned server does not match your client, VS Code just falls back to downloading its own version; the pre-installed extensions are version-independent and are reused anyway.
A .devcontainer.json is generated next to the Dockerfile pointing to the image built by 10-build.sh, so opening that folder in VS Code offers “Reopen in Container” automatically.
codebase-memory-deployv
The image ships with codebase-memory-deployv, a wrapper that deploys codebase-memory-mcp (code knowledge graph for AI agents) for instances following this layout.
The repository is not indexed while building the image. Run inside the container:
codebase-memory-deployv
It installs codebase-memory-mcp if it is missing, derives the project name from ${MAIN_REPO_FULL_PATH}/variables.sh (e.g. forecast_17.0), and indexes /home/odoo/instance in batches of modules. Indexing takes a few minutes on a big instance, so it is left as an explicit step for the user.
Depends
SSH key without password
Dockerfile doesn’t support a prompt to enter your password, so you need to remove it from your ssh keys.
Recommended: use Ed25519 keys. The tool copies ~/.ssh/id_ed25519.pub to the container’s authorized_keys and warns if only RSA keys are found.
export fname=~/.ssh/id_ed25519
cp ${fname} ${fname}_with_pwd
ssh-keygen -p -N "" -f ${fname}
For legacy RSA keys:
export fname=~/.ssh/id_rsa
cp ${fname} ${fname}_with_pwd
openssl rsa -in ${fname} -out ${fname}_without_pwd
cp ${fname}_without_pwd ${fname}
Install docker
Documentation
Development
To run the all tests run:
tox
Note, to combine the coverage data from all the tox environments run:
Windows |
set PYTEST_ADDOPTS=--cov-append tox |
|---|---|
Other |
PYTEST_ADDOPTS=--cov-append tox |
Release process
This project uses bump2version to manage version bumps across .bumpversion.cfg, docs/conf.py, setup.py and src/travis2docker/__init__.py.
Requirements
Write access to push to main and to push tags.
A GPG key configured for signing git tags. The CI pipeline that publishes the package to PyPI only builds from signed tags:
git config --global user.signingkey <YOUR_GPG_KEY_ID>
bump2version installed:
pip install bump2version
Steps to release a new version
Make sure you are on main and it is up to date, with no local commits ahead of origin:
git checkout main git pull origin main git status # must be clean
Bump the version. This creates a commit and a tag automatically (choose patch, minor or major as needed):
bump2version patch
This updates:
.bumpversion.cfg docs/conf.py setup.py src/travis2docker/__init__.py
Verify the tag was created and that it is signed:
git tag -v vX.Y.Z
If sign_tags is not enabled in .bumpversion.cfg, the tag created in step 2 will not be signed and the CI build/publish step will not run. In that case, re-create the tag manually before pushing:
git tag -d vX.Y.Z git tag -s vX.Y.Z -m "vX.Y.Z"
To avoid this every time, add the following to .bumpversion.cfg:
[bumpversion] current_version = X.Y.Z commit = True tag = True sign_tags = True
Push the branch and the tag:
git push origin main --tags
Pushing the signed tag is what triggers the CI job that builds and publishes the package to PyPI.
Troubleshooting
“tag already exists” / dirty working tree: make sure git status is clean and git pull origin main was run before bump2version, otherwise the bump commit/tag will be based on stale history.
CI does not trigger a PyPI build: check that the pushed tag is signed (git tag -v vX.Y.Z should show a valid GPG signature) and that user.signingkey is configured correctly.
Changelog
3.0.0 (2016-07-26)
First release on PyPI.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file travis2docker-7.0.3.tar.gz.
File metadata
- Download URL: travis2docker-7.0.3.tar.gz
- Upload date:
- Size: 35.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2f66e54b5717602ea970d5c9143ee568e6a8d0ce94ad8560fb3fd023cdee93b
|
|
| MD5 |
9fb09c07db5c299da537a65318497c17
|
|
| BLAKE2b-256 |
ccee0acce8d907131930d8ef1ce3abf02e7c750709cf6369c1fed28a08cadcfc
|
File details
Details for the file travis2docker-7.0.3-py3-none-any.whl.
File metadata
- Download URL: travis2docker-7.0.3-py3-none-any.whl
- Upload date:
- Size: 29.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9cb2adbdeeef0e9e0d8b0ad909a86e8f99e7712570a73d165282127885f5e20d
|
|
| MD5 |
73700a464da38abc1b87fd16b331fd52
|
|
| BLAKE2b-256 |
419c925c23957845d44c77ca342ae26dfb725b1e3cb2c5667b61a2fcce9939a6
|
