Add instructions for running a openQA/tools dev environment #6590
Conversation
perlpunk
force-pushed
the
devcontainer
branch
4 times, most recently
from
f7318e9 to
ed94d79
Compare
container/devel/README.md
Outdated
| # Setup a Development Enviroment for openQA and related Tools | ||
|
|
||
| These examples use `podman` and | ||
| [`distrobox`](https://en.opensuse.org/Distrobox). You can use similar tools | ||
| like `docker`, `toolbox` etc. to achieve the same. | ||
|
|
||
| You will run two containers: | ||
| * A separate postgres container (so you don't have to deal with the database | ||
| when updating your dev container) | ||
| * The openQA environment in a openSUSE Leap or Tumbleweed container, which | ||
| both can use the same postgres container. | ||
| In this example we will be settting up and using the Leap container. |
There was a problem hiding this comment.
I suggest to link to http://open.qa/docs/#contributing if not rather move the documentation there. Right now unfortunately it seems this documentation is a complete alternative to http://open.qa/docs/#development-setup confusing users which instructions they should follow.
There was a problem hiding this comment.
That's why it's a draft
perlpunk
force-pushed
the
devcontainer
branch
3 times, most recently
from
443aa23 to
6bc5a74
Compare
|
We could of course also leave out the Dockerfiles and leave that as a suggestion for those who want it. |
|
Great PR! Please pay attention to the following items before merging: Files matching
This is an automatically generated QA checklist based on modified files. |
perlpunk
force-pushed
the
devcontainer
branch
2 times, most recently
from
7d261ae to
7cd6d3c
Compare
|
I moved everything to |
| os-autoinst-devel openQA-devel \ | ||
| os-autoinst-scripts-deps \ | ||
| os-autoinst-scripts-deps-devel \ | ||
| openssh-clients \ |
There was a problem hiding this comment.
openssh-clients is necessary to do git clone git@...
Should we add it to os-autoinst and openQA requirements?
There was a problem hiding this comment.
There is also a https://open.qa/docs/#containerizedsetup
I am not sure where the === Quick container setup should be placed. Personally:
- rename it to
Development setup in containersor something like that. - I would place it between
Dependenciesand the nextConducting tests. At least in the structure which the document is now. The reason is that you need a setup before even look to the next instructions likeConducting tests
| For the lazy, check out the <<Contributing.asciidoc#quick-container-setup,Quick | ||
| container setup>> with instructions you can mostly copy & paste. |
There was a problem hiding this comment.
This is the very first line of the Development setup and it would be more enlightening to describe the options or the differences from other sections. Something like
In order to contribute, your development environment needs the following steps [blabla].. In order to setup a containerized env follow these instructions....[]
Issue: https://progress.opensuse.org/issues/184459
https://github.com/perlpunk/openQA/blob/devcontainer/container/devel/README.md