kiwi-stackbuild-plugin 1.0.7__tar.gz → 1.0.11__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/.bumpversion.cfg +3 -2
  2. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/Makefile +31 -16
  3. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/PKG-INFO +19 -11
  4. kiwi_stackbuild_plugin-1.0.11/doc/Makefile +223 -0
  5. kiwi_stackbuild_plugin-1.0.11/doc/source/commands/system_stackbuild.rst +100 -0
  6. kiwi_stackbuild_plugin-1.0.11/doc/source/commands/system_stash.rst +52 -0
  7. kiwi_stackbuild_plugin-1.0.11/doc/source/commands.rst +8 -0
  8. kiwi_stackbuild_plugin-1.0.11/doc/source/conf.py +117 -0
  9. kiwi_stackbuild_plugin-1.0.11/doc/source/index.rst +4 -0
  10. kiwi_stackbuild_plugin-1.0.11/helper/rebuild_changelog_reference.sh +6 -0
  11. kiwi_stackbuild_plugin-1.0.11/helper/update_changelog.py +134 -0
  12. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/kiwi_stackbuild_plugin/tasks/system_stackbuild.py +3 -3
  13. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/kiwi_stackbuild_plugin/version.py +1 -1
  14. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/package/python-kiwi_stackbuild_plugin-spec-template +60 -13
  15. kiwi_stackbuild_plugin-1.0.11/pyproject.toml +87 -0
  16. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/setup.cfg +6 -6
  17. kiwi_stackbuild_plugin-1.0.11/test/data/image-root/image/config.xml +29 -0
  18. kiwi_stackbuild_plugin-1.0.11/test/data/image-root-invalid-name/image/config.xml +29 -0
  19. kiwi_stackbuild_plugin-1.0.11/test/unit/.coveragerc +7 -0
  20. kiwi_stackbuild_plugin-1.0.11/test/unit/__init__.py +0 -0
  21. kiwi_stackbuild_plugin-1.0.11/test/unit/defaults_test.py +11 -0
  22. kiwi_stackbuild_plugin-1.0.11/test/unit/tasks/__init__.py +0 -0
  23. kiwi_stackbuild_plugin-1.0.11/test/unit/tasks/system_stackbuild_test.py +193 -0
  24. kiwi_stackbuild_plugin-1.0.11/test/unit/tasks/system_stash_test.py +149 -0
  25. kiwi_stackbuild_plugin-1.0.7/.virtualenv.dev-requirements.txt +0 -38
  26. kiwi_stackbuild_plugin-1.0.7/.virtualenv.requirements.txt +0 -8
  27. kiwi_stackbuild_plugin-1.0.7/MANIFEST.in +0 -18
  28. kiwi_stackbuild_plugin-1.0.7/kiwi_stackbuild_plugin.egg-info/PKG-INFO +0 -33
  29. kiwi_stackbuild_plugin-1.0.7/kiwi_stackbuild_plugin.egg-info/SOURCES.txt +0 -27
  30. kiwi_stackbuild_plugin-1.0.7/kiwi_stackbuild_plugin.egg-info/dependency_links.txt +0 -1
  31. kiwi_stackbuild_plugin-1.0.7/kiwi_stackbuild_plugin.egg-info/entry_points.txt +0 -4
  32. kiwi_stackbuild_plugin-1.0.7/kiwi_stackbuild_plugin.egg-info/not-zip-safe +0 -1
  33. kiwi_stackbuild_plugin-1.0.7/kiwi_stackbuild_plugin.egg-info/requires.txt +0 -3
  34. kiwi_stackbuild_plugin-1.0.7/kiwi_stackbuild_plugin.egg-info/top_level.txt +0 -1
  35. kiwi_stackbuild_plugin-1.0.7/setup.py +0 -54
  36. kiwi_stackbuild_plugin-1.0.7/tox.ini +0 -113
  37. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/LICENSE +0 -0
  38. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/README.rst +0 -0
  39. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/kiwi_stackbuild_plugin/__init__.py +0 -0
  40. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/kiwi_stackbuild_plugin/defaults.py +0 -0
  41. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/kiwi_stackbuild_plugin/exceptions.py +0 -0
  42. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/kiwi_stackbuild_plugin/tasks/__init__.py +0 -0
  43. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/kiwi_stackbuild_plugin/tasks/system_stash.py +0 -0
  44. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/package/python-kiwi_stackbuild_plugin-rpmlintrc +0 -0
  45. {kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.11}/package/python-kiwi_stackbuild_plugin.changes +0 -0
@@ -1,9 +1,10 @@
1
1
  [bumpversion]
2
- current_version = 1.0.7
2
+ current_version = 1.0.11
3
3
  commit = True
4
4
  tag = True
5
5
 
6
+ [bumpversion:file:pyproject.toml]
7
+
6
8
  [bumpversion:file:kiwi_stackbuild_plugin/version.py]
7
9
 
8
10
  [bumpversion:file:doc/source/conf.py]
9
-
@@ -9,32 +9,45 @@ version := $(shell \
9
9
  'from kiwi_stackbuild_plugin.version import __version__; print(__version__)'\
10
10
  )
11
11
 
12
- tox:
13
- tox "-n 5"
14
-
15
12
  install:
16
13
  # install plugin manual page and license/readme
17
14
  # NOTE: this file is not handled through pip because on system level
18
15
  install -d -m 755 ${buildroot}usr/share/man/man8
19
16
  gzip -f doc/build/man/kiwi::system::stackbuild.8
17
+ gzip -f doc/build/man/kiwi::system::stash.8
20
18
  install -m 644 doc/build/man/kiwi::system::stackbuild.8.gz \
21
19
  ${buildroot}usr/share/man/man8
20
+ install -m 644 doc/build/man/kiwi::system::stash.8.gz \
21
+ ${buildroot}usr/share/man/man8
22
22
  install -d -m 755 ${buildroot}${docdir}/python-kiwi_stackbuild_plugin
23
23
  install -m 644 LICENSE \
24
24
  ${buildroot}${docdir}/python-kiwi_stackbuild_plugin/LICENSE
25
25
  install -m 644 README.rst \
26
26
  ${buildroot}${docdir}/python-kiwi_stackbuild_plugin/README
27
27
 
28
- build: clean tox
29
- # create setup.py variant for rpm build.
30
- # delete module versions from setup.py for building an rpm
31
- # the dependencies to the python module rpm packages is
32
- # managed in the spec file
33
- sed -ie "s@>=[0-9.]*'@'@g" setup.py
28
+ setup:
29
+ poetry install --all-extras
30
+
31
+ docs: setup
32
+ poetry run make -C doc man
33
+
34
+ check: setup
35
+ # python flake tests
36
+ poetry run flake8 --statistics -j auto --count kiwi_stackbuild_plugin
37
+ poetry run flake8 --statistics -j auto --count test/unit
38
+
39
+ test: setup
40
+ # python static code checks
41
+ poetry run mypy kiwi_stackbuild_plugin
42
+ # unit tests
43
+ poetry run bash -c 'pushd test/unit && pytest -n 5 \
44
+ --doctest-modules --no-cov-on-fail --cov=kiwi_stackbuild_plugin \
45
+ --cov-report=term-missing --cov-fail-under=100 \
46
+ --cov-config .coveragerc'
47
+
48
+ build: clean check test
34
49
  # build the sdist source tarball
35
- $(python) setup.py sdist
36
- # restore original setup.py backed up from sed
37
- mv setup.pye setup.py
50
+ poetry build --format=sdist
38
51
  # provide rpm source tarball
39
52
  mv dist/kiwi_stackbuild_plugin-${version}.tar.gz \
40
53
  dist/python-kiwi-stackbuild-plugin.tar.gz
@@ -52,10 +65,12 @@ build: clean tox
52
65
  # provide rpm rpmlintrc
53
66
  cp package/python-kiwi_stackbuild_plugin-rpmlintrc dist
54
67
 
55
- pypi: clean tox
56
- $(python) setup.py sdist upload
68
+ prepare_for_pypi: clean setup
69
+ # sdist tarball, the actual publishing happens via the
70
+ # ci-publish-to-pypi.yml github action
71
+ poetry build --format=sdist
57
72
 
58
73
  clean:
59
- $(python) setup.py clean
74
+ rm -rf dist
60
75
  rm -rf doc/build
61
- rm -rf dist/*
76
+ rm -rf doc/dist
@@ -1,21 +1,30 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: kiwi_stackbuild_plugin
3
- Version: 1.0.7
3
+ Version: 1.0.11
4
4
  Summary: KIWI - Stack Build Plugin
5
- Home-page: https://github.com/OSInside/kiwi-stackbuild-plugin
6
- Author: Marcus Schaefer
7
- Author-email: ms@suse.com
8
- License: GPLv3+
9
- Download-URL: https://download.opensuse.org/repositories/Virtualization:/Appliances:/Builder
10
- Platform: UNKNOWN
5
+ Home-page: https://osinside.github.io/kiwi/
6
+ License: GPL-3.0-or-later
7
+ Author: Marcus Schäfer
8
+ Author-email: marcus.schaefer@suse.com
9
+ Maintainer: Marcus Schäfer
10
+ Maintainer-email: marcus.schaefer@suse.com
11
+ Requires-Python: >=3.9,<4.0
11
12
  Classifier: Development Status :: 5 - Production/Stable
12
13
  Classifier: Intended Audience :: Developers
13
14
  Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
14
15
  Classifier: Operating System :: POSIX :: Linux
15
- Classifier: Programming Language :: Python :: 3.6
16
- Classifier: Programming Language :: Python :: 3.8
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.9
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
17
21
  Classifier: Topic :: System :: Operating System
18
- License-File: LICENSE
22
+ Requires-Dist: docopt-ng (>=0.9.0)
23
+ Requires-Dist: kiwi (>=9.21.21)
24
+ Project-URL: Bug Tracker, https://github.com/OSInside/kiwi-stackbuild-plugin/issues
25
+ Project-URL: Documentation, https://osinside.github.io/kiwi/plugins/stackbuild.html
26
+ Project-URL: Repository, https://github.com/OSInside/kiwi-stackbuild-plugin
27
+ Description-Content-Type: text/x-rst
19
28
 
20
29
  KIWI - Stack Build Plugin
21
30
  =========================
@@ -30,4 +39,3 @@ and reuse KIWI built root-trees as OCI containers. The idea is using OCI images
30
39
  as portable format to store and distribute a root-tree, so they can be pushed
31
40
  and pulled from OCI registries.
32
41
 
33
-
@@ -0,0 +1,223 @@
1
+ # Makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line.
5
+ SPHINXOPTS =
6
+ SPHINXBUILD = sphinx-build
7
+ PAPER =
8
+ BUILDDIR = build
9
+
10
+ # User-friendly check for sphinx-build
11
+ ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12
+ $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13
+ endif
14
+
15
+ # Internal variables.
16
+ PAPEROPT_a4 = -D latex_paper_size=a4
17
+ PAPEROPT_letter = -D latex_paper_size=letter
18
+ ALLSPHINXOPTS = -W -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19
+ # the i18n builder cannot share the environment and doctrees with the others
20
+ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21
+
22
+ .PHONY: help
23
+ help:
24
+ @echo "Please use \`make <target>' where <target> is one of"
25
+ @echo " html to make standalone HTML files"
26
+ @echo " dirhtml to make HTML files named index.html in directories"
27
+ @echo " singlehtml to make a single large HTML file"
28
+ @echo " pickle to make pickle files"
29
+ @echo " json to make JSON files"
30
+ @echo " htmlhelp to make HTML files and a HTML help project"
31
+ @echo " qthelp to make HTML files and a qthelp project"
32
+ @echo " applehelp to make an Apple Help Book"
33
+ @echo " devhelp to make HTML files and a Devhelp project"
34
+ @echo " epub to make an epub"
35
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
37
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38
+ @echo " text to make text files"
39
+ @echo " man to make manual pages"
40
+ @echo " texinfo to make Texinfo files"
41
+ @echo " info to make Texinfo files and run them through makeinfo"
42
+ @echo " gettext to make PO message catalogs"
43
+ @echo " changes to make an overview of all changed/added/deprecated items"
44
+ @echo " xml to make Docutils-native XML files"
45
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
46
+ @echo " linkcheck to check all external links for integrity"
47
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
48
+ @echo " coverage to run coverage check of the documentation (if enabled)"
49
+ @echo " spell to run spell-checking"
50
+
51
+ .PHONY: clean
52
+ clean:
53
+ rm -rf $(BUILDDIR)/
54
+
55
+ .PHONY: html
56
+ html:
57
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html && cp -a source/development/schema/images $(BUILDDIR)/html/development || true
58
+ @echo
59
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
60
+
61
+ .PHONY: dirhtml
62
+ dirhtml:
63
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
64
+ @echo
65
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
66
+
67
+ .PHONY: singlehtml
68
+ singlehtml:
69
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
70
+ @echo
71
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
72
+
73
+ .PHONY: pickle
74
+ pickle:
75
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
76
+ @echo
77
+ @echo "Build finished; now you can process the pickle files."
78
+
79
+ .PHONY: json
80
+ json:
81
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
82
+ @echo
83
+ @echo "Build finished; now you can process the JSON files."
84
+
85
+ .PHONY: htmlhelp
86
+ htmlhelp:
87
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
88
+ @echo
89
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
90
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
91
+
92
+ .PHONY: qthelp
93
+ qthelp:
94
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
95
+ @echo
96
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
97
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
98
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/kiwi.qhcp"
99
+ @echo "To view the help file:"
100
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/kiwi.qhc"
101
+
102
+ .PHONY: applehelp
103
+ applehelp:
104
+ $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
105
+ @echo
106
+ @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
107
+ @echo "N.B. You won't be able to view it unless you put it in" \
108
+ "~/Library/Documentation/Help or install it in your application" \
109
+ "bundle."
110
+
111
+ .PHONY: devhelp
112
+ devhelp:
113
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
114
+ @echo
115
+ @echo "Build finished."
116
+ @echo "To view the help file:"
117
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/kiwi"
118
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/kiwi"
119
+ @echo "# devhelp"
120
+
121
+ .PHONY: epub
122
+ epub:
123
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
124
+ @echo
125
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
126
+
127
+ .PHONY: latex
128
+ latex:
129
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
130
+ @echo
131
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
132
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
133
+ "(use \`make latexpdf' here to do that automatically)."
134
+
135
+ .PHONY: latexpdf
136
+ latexpdf:
137
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
138
+ @echo "Running LaTeX files through pdflatex..."
139
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
140
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
141
+
142
+ .PHONY: latexpdfja
143
+ latexpdfja:
144
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
145
+ @echo "Running LaTeX files through platex and dvipdfmx..."
146
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
147
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
148
+
149
+ .PHONY: text
150
+ text:
151
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
152
+ @echo
153
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
154
+
155
+ .PHONY: man
156
+ man:
157
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
158
+ @echo
159
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
160
+
161
+ .PHONY: texinfo
162
+ texinfo:
163
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
164
+ @echo
165
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
166
+ @echo "Run \`make' in that directory to run these through makeinfo" \
167
+ "(use \`make info' here to do that automatically)."
168
+
169
+ .PHONY: info
170
+ info:
171
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
172
+ @echo "Running Texinfo files through makeinfo..."
173
+ make -C $(BUILDDIR)/texinfo info
174
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
175
+
176
+ .PHONY: gettext
177
+ gettext:
178
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
179
+ @echo
180
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
181
+
182
+ .PHONY: changes
183
+ changes:
184
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
185
+ @echo
186
+ @echo "The overview file is in $(BUILDDIR)/changes."
187
+
188
+ .PHONY: linkcheck
189
+ linkcheck:
190
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
191
+ @echo
192
+ @echo "Link check complete; look for any errors in the above output " \
193
+ "or in $(BUILDDIR)/linkcheck/output.txt."
194
+
195
+ .PHONY: doctest
196
+ doctest:
197
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
198
+ @echo "Testing of doctests in the sources finished, look at the " \
199
+ "results in $(BUILDDIR)/doctest/output.txt."
200
+
201
+ .PHONY: coverage
202
+ coverage:
203
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
204
+ @echo "Testing of coverage in the sources finished, look at the " \
205
+ "results in $(BUILDDIR)/coverage/python.txt."
206
+
207
+ .PHONY: xml
208
+ xml:
209
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
210
+ @echo
211
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
212
+
213
+ .PHONY: pseudoxml
214
+ pseudoxml:
215
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
216
+ @echo
217
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
218
+
219
+ .PHONY: spell
220
+ spell:
221
+ $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
222
+ @echo
223
+ @echo "Spell-checking complete. Find results in $(BUILDDIR)/spelling."
@@ -0,0 +1,100 @@
1
+ kiwi-ng system stackbuild
2
+ =========================
3
+
4
+ SYNOPSIS
5
+ --------
6
+
7
+ .. code:: bash
8
+
9
+ kiwi-ng system stackbuild -h | --help
10
+ kiwi-ng system stackbuild --stash=<name>... --description=<directory> --target-dir=<directory>
11
+ [--from-registry=<URI>]
12
+ [-- <kiwi_build_command_args>...]
13
+ kiwi-ng system stackbuild --stash=<name>... --target-dir=<directory>
14
+ [--from-registry=<URI>]
15
+ [-- <kiwi_create_command_args>...]
16
+ kiwi-ng system stackbuild help
17
+
18
+ DESCRIPTION
19
+ -----------
20
+
21
+ This [KIWI](https://osinside.github.io/kiwi/) plugin allows to store
22
+ and reuse KIWI built root-trees as OCI containers. The idea is using OCI images
23
+ as portable format to store and distribute a root-tree, so they can be pushed
24
+ and pulled from OCI registries.
25
+
26
+ This plugin allows the user to operate in two modes
27
+
28
+ 1. Rebuild an image from a stash
29
+
30
+ In this mode `stackbuild` takes a stash, makes it available to the
31
+ local registry and builds the image using the stash rootfs and
32
+ in stash stored image description.
33
+
34
+ .. code:: bash
35
+
36
+ $ kiwi-ng system stackbuild --stash NAME \
37
+ --target-dir /target/rebuild
38
+
39
+
40
+ 2. Build an image based on a stash
41
+
42
+ In this mode `stackbuild` takes a stash, makes it available to the
43
+ local registry and uses the stash rootfs as the base for an image
44
+ build of another image description.
45
+
46
+ .. code:: bash
47
+
48
+ $ kiwi-ng system stackbuild --stash NAME \
49
+ --description=/some/image-description --target-dir /target/rebuild
50
+
51
+ .. note::
52
+
53
+ The stackbuild plugin does not perform any consistency check
54
+ if the used stash rootfs is compatible with the provided image
55
+ description. With that in mind there is nothing which would
56
+ prevent you from using a Leap stash and try to build a Fedora
57
+ image on top of it. That an attempt like this will not produce
58
+ anything useful should be clear to the user and is in the
59
+ users responsibility to prevent combining apples with pears
60
+
61
+ OPTIONS
62
+ -------
63
+
64
+ --stash=<name>
65
+
66
+ Name of the stash. See `system stash --list` for available stashes.
67
+ Multiple stashes will be stacked together in the given order
68
+
69
+ --from-registry=<URI>
70
+
71
+ Pull given stash container name from the provided
72
+ registry URI
73
+
74
+ --description=<directory>
75
+
76
+ Path to the XML description. This is a directory containing at least
77
+ one _config.xml_ or _*.kiwi_ XML file.
78
+
79
+ --target-dir=<directory>
80
+
81
+ Path to store the build results.
82
+
83
+ -- <kiwi_build_command_args>...
84
+
85
+ List of command parameters as supported by the kiwi-ng
86
+ build command. The information given here is passed
87
+ along to the `kiwi-ng system build` command.
88
+
89
+ -- <kiwi_create_command_args>...
90
+
91
+ List of command parameters as supported by the kiwi-ng
92
+ build command. The information given here is passed
93
+ along to the `kiwi-ng system create` command.
94
+
95
+ EXAMPLE
96
+ -------
97
+
98
+ .. code:: bash
99
+
100
+ $ kiwi-ng system stackbuild --stash NAME --target-dir /target/rebuild
@@ -0,0 +1,52 @@
1
+ kiwi-ng system stash
2
+ ====================
3
+
4
+ SYNOPSIS
5
+ --------
6
+
7
+ .. code:: bash
8
+
9
+ kiwi-ng [global options] service <command> [<args>]
10
+
11
+ kiwi-ng system stash -h | --help
12
+ kiwi-ng system stash --root=<directory>
13
+ [--tag=<name>]
14
+ [--container-name=<name>]
15
+ kiwi-ng system stash --list
16
+ kiwi-ng system stash help
17
+
18
+ DESCRIPTION
19
+ -----------
20
+
21
+ Create a container from the given root directory. The command
22
+ takes the contents of the given root directory at call time
23
+ and creates a container from it.
24
+
25
+ OPTIONS
26
+ -------
27
+
28
+ --root=<directory>
29
+
30
+ The path to the root directory, usually the result of
31
+ a former system prepare or build call
32
+
33
+ --tag=<name>
34
+
35
+ The tag name for the container. By default 'latest'
36
+ is used
37
+
38
+ --container-name=<name>
39
+
40
+ The name of the container. By default
41
+ set to the image name of the stash
42
+
43
+ --list
44
+
45
+ list the available stashes
46
+
47
+ EXAMPLE
48
+ -------
49
+
50
+ .. code:: bash
51
+
52
+ $ kiwi-ng system stash --root /tmp/mytest/build/image-root
@@ -0,0 +1,8 @@
1
+ Command Line
2
+ ============
3
+
4
+ .. toctree::
5
+ :maxdepth: 1
6
+
7
+ commands/system_stackbuild
8
+ commands/system_stash
@@ -0,0 +1,117 @@
1
+ #!/usr/bin/env python3
2
+ # -*- coding: utf-8 -*-
3
+ #
4
+ # KIWI NG documentation build configuration file
5
+ #
6
+ import sys
7
+ from os.path import abspath, dirname, join, normpath
8
+ import shlex
9
+ import sphinx_rtd_theme
10
+
11
+ # If extensions (or modules to document with autodoc) are in another directory,
12
+ # add these directories to sys.path here. If the directory is relative to the
13
+ # documentation root, use os.path.abspath to make it absolute, like shown here.
14
+ _path = normpath(join(dirname(__file__), "../.."))
15
+ sys.path.insert(0, _path)
16
+
17
+
18
+ # -- General configuration ------------------------------------------------
19
+
20
+ extensions = [
21
+ 'sphinx.ext.extlinks',
22
+ 'sphinx.ext.viewcode',
23
+ ]
24
+
25
+ # Add any paths that contain templates here, relative to this directory.
26
+ templates_path = ['.templates']
27
+
28
+ # The suffix(es) of source filenames.
29
+ # You can specify multiple suffix as a list of string:
30
+ # source_suffix = ['.rst', '.md']
31
+ source_suffix = '.rst'
32
+
33
+ # The encoding of source files.
34
+ source_encoding = 'utf-8-sig'
35
+
36
+ # The master toctree document.
37
+ master_doc = 'index'
38
+
39
+ default_role="py:obj"
40
+
41
+ # General information about the project.
42
+ project = 'KIWI - Stack Build Plugin'
43
+ copyright = '2021, Marcus Schäfer'
44
+ author = 'Marcus Schäfer'
45
+
46
+ # The version info for the project you're documenting, acts as replacement for
47
+ # |version| and |release|, also used in various other places throughout the
48
+ # built documents.
49
+ #
50
+ # The short X.Y version.
51
+ version = '1.0.11'
52
+ # The full version, including alpha/beta/rc tags.
53
+ release = version
54
+
55
+ # The language for content autogenerated by Sphinx. Refer to documentation
56
+ # for a list of supported languages.
57
+ #
58
+ # This is also used if you do content translation via gettext catalogs.
59
+ # Usually you set "language" from the command line for these cases.
60
+ language = 'en'
61
+
62
+ # List of patterns, relative to source directory, that match files and
63
+ # directories to ignore when looking for source files.
64
+ exclude_patterns = []
65
+
66
+ # The name of the Pygments (syntax highlighting) style to use.
67
+ pygments_style = 'sphinx'
68
+
69
+ # If true, `todo` and `todoList` produce output, else they produce nothing.
70
+ todo_include_todos = True
71
+
72
+ autosummary_generate = True
73
+
74
+ # -- Options for HTML output ----------------------------------------------
75
+
76
+ html_sidebars = {
77
+ '**': [
78
+ 'localtoc.html', 'relations.html',
79
+ 'about.html', 'searchbox.html',
80
+ ]
81
+ }
82
+
83
+ html_theme = "sphinx_rtd_theme"
84
+
85
+ # html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
86
+
87
+ html_theme_options = {
88
+ 'collapse_navigation': False,
89
+ 'display_version': False
90
+ }
91
+
92
+ # -- Options for manual page output ---------------------------------------
93
+
94
+ # The man page toctree documents.
95
+ system_stackbuild_doc = 'commands/system_stackbuild'
96
+ system_stash_doc = 'commands/system_stash'
97
+
98
+ # One entry per manual page. List of tuples
99
+ # (source start file, name, description, authors, manual section).
100
+ man_pages = [
101
+ (
102
+ system_stackbuild_doc,
103
+ 'kiwi::system::stackbuild',
104
+ 'Stack Build Plugin',
105
+ [author],
106
+ 8
107
+ ),
108
+ (
109
+ system_stash_doc,
110
+ 'kiwi::system::stash',
111
+ 'Stack Build Plugin',
112
+ [author],
113
+ 8
114
+ )
115
+ ]
116
+
117
+ intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
@@ -0,0 +1,4 @@
1
+ .. toctree::
2
+ :maxdepth: 1
3
+
4
+ commands
@@ -0,0 +1,6 @@
1
+ #!/bin/bash
2
+
3
+ git log --no-merges --format=fuller > package/python-kiwi.changes
4
+
5
+ git commit -S -m 'Update changelog reference' \
6
+ package/python-kiwi.changes