Skip to content
Prev Previous commit
Next Next commit
[DOC] readme: update paths, add .t2d.yml, recommend Ed25519 SSH keys
- Correct output directory structure to match actual code behavior
  (python_version/env_N_job_M instead of flat /1, /2)
- Document .t2d.yml as alternative config file name
- Clarify that HTTPS URLs are also accepted
- Add Ed25519 key instructions as recommended (matching code behavior)
- Keep RSA instructions as legacy fallback
- Note that 10-build.sh already uses --pull so manual pull is optional
- Fix typo: 'into of' -> 'inside of'
  • Loading branch information
nhomar committed Feb 14, 2026
commit 33ab1d2fc2786eb41616442773dd3f3d0deb9ab9
30 changes: 23 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,10 @@ Usage
Or with pull request
`travisfile2dockerfile REPO_URL pull/##`

In REPO_URL use the ssh url of github.
In REPO_URL use the ssh or https url of the git repository.

The tool reads the ``.travis.yml`` (or ``.t2d.yml``) file from the repository and
branch specified, generating Dockerfiles and helper scripts.

For more information execute:
`travisfile2dockerfile --help`
Expand All @@ -81,18 +84,19 @@ 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/1`
`${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/2`
`${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/2_7/env_1_job_1`
`${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/2_7/env_2_job_1`

The first one is the build for env `TESTS=1`, the second one is for env with `LINT_CHECK=1`
Where ``2_7`` is the Python version (dots replaced by underscores), and
``env_N_job_M`` identifies the environment/job matrix combination.

To build image:
`${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/1/10-build.sh`
`${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/2_7/env_1_job_1/10-build.sh`

To create container:
`${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/1/20-run.sh --entrypoint=bash`
`${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/2_7/env_1_job_1/20-run.sh --entrypoint=bash`

To run the test (into of container):
To run the test (inside of container):
`/entrypoint.sh`

Depends
Expand All @@ -103,6 +107,16 @@ 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 will warn if only RSA is 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
Expand All @@ -114,6 +128,8 @@ Download the big image
**********************

Travis2docker uses a default image with many packages pre-installed.
The ``10-build.sh`` script uses ``docker build --pull`` which will fetch the
image automatically, but you can pre-download it:

`docker pull vauxoo/odoo-80-image-shippable-auto`

Expand Down
Loading