Skip to content

Replace tilt for docker compose in the contributing docs #355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jlaneve merged 2 commits into from
Jul 4, 2023
Merged

Replace tilt for docker compose in the contributing docs #355

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd56394
remove unused .env file
giovannicorsetti Jun 30, 2023
19c1cba
changing contributing.rst file
giovannicorsetti Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 7 additions & 13 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,34 +57,28 @@ If testing for the same Airflow and Python version, next runs of the integration
hatch run tests.py3.8-2.5:test-integration


Using Tilt for local development
________________________________

It is also possible to use `tilt <https://docs.tilt.dev>`_, a toolkit which helps on microservices local development.

Using Docker Compose for local development
---------------------------------

Pre-requisites
++++++++++++++
It is also possible to just build the development environment using docker compose

#. `tilt <https://docs.tilt.dev>`_
#. `git <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_

Local Sandbox
+++++++++++++

For local development, we use `Tilt <https://docs.tilt.dev>`_. To use Tilt, first clone the ``astronomer-cosmos`` repo:
To launch a local sandbox with docker compose, first clone the ``astronomer-cosmos`` repo:

.. code-block:: bash

git clone https://github.com/astronomer/astronomer-cosmos.git

Then, run the following from the ``astronomer-cosmos`` directory:
Then, run the following command from the ``astronomer-cosmos`` directory:

.. code-block:: bash

tilt up
docker compose -f dev/docker-compose.yaml up -d --build

You can press ``space`` to open the Tilt UI and see the status of the sandbox. Once the sandbox is up, you can access the Airflow UI at ``http://localhost:8080``.
Once the sandbox is up, you can access the Airflow UI at ``http://localhost:8080``.


Pre-Commit
Expand Down