Skip to content
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.

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

Split package module further to avoid recursive imports #715

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Or to update all images for a service pack, run:


If you do not want to interact with OBS at all, then you can also use the
:file:`src/bci_build/package.py` script to just write the files of a single
:file:`src/bci_build/package/__init__.py` script to just write the files of a single
package into a directory:

.. code-block:: console
Expand Down
8 changes: 4 additions & 4 deletions source/adding_containers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
Adding and Modifying Container Images
=====================================

All container images are defined in :file:`src/bci_build/package.py` as
instances of the :py:class:`~bci_build.package.LanguageStackContainer`,
:py:class:`~bci_build.package.ApplicationStackContainer` or
:py:class:`~bci_build.package.OsContainer` classes.
All container images are defined in :file:`src/bci_build/package/` as
instances of the :py:class:`~bci_build.package.bciclasses.LanguageStackContainer`,
:py:class:`~bci_build.package.bciclasses.ApplicationStackContainer` or
:py:class:`~bci_build.package.bciclasses.OsContainer` classes.

The different classes result in slightly different images, mostly with respect
to the way versions, tags and labels are handled. For example instances of
Expand Down
4 changes: 2 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------

project = "bci-build-templates"
copyright = "2022, Dan Čermák"
project = "BCI-dockerfile-generator"
copyright = "2023, SUSE LLC"
author = "Dan Čermák"


Expand Down
6 changes: 3 additions & 3 deletions source/creating_packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ If you want to create a new Container Image on OBS, then proceed as follows:

$ osc mkpac $new_pkg_name

4. Run the script :command:`./src/bci_build/package.py` as follows:
4. Run the :command:`package` as follows:

.. code-block:: console

$ poetry run ./src/bci_build/package.py $new_container_nvr-$SP_ID path_to_checkout_of_new_pkg_name
$ poetry run package $new_container_nvr-$SP_ID path_to_checkout_of_new_pkg_name

where ``$new_container_nvr`` is the value of the
:py:attr:`~bci_build.package.BaseContainerImage.uid` property of your
Expand All @@ -44,7 +44,7 @@ If you want to create a new Container Image on OBS, then proceed as follows:
:py:attr:`~bci_build.package.LanguageStackContainer.version`, depending on
the type of the container) and ``$SP_ID`` the identifier of this service pack
(e.g. ``sp4`` or ``sp3``). You can find all available containers via
:command:`poetry ./src/bci_build/package.py --help`.
:command:`poetry run package --help`.

``path_to_checkout_of_new_pkg_name`` is the path where you have checked out
the *package* ``$new_pkg_name`` to.
Expand Down
Loading
Loading