Skip to content

Commit fed4375

Browse files
committed
doc: add testing links to doc/rtd Development headings (#6326)
Migrate package testing build info into existing testing page.
1 parent 6979999 commit fed4375

File tree

6 files changed

+39
-29
lines changed

6 files changed

+39
-29
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Contribute to testing
2+
*********************
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
package_testing.rst
8+
ubuntu_test_prerelease.rst
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _package_testing:
2+
3+
Development package builds
4+
**************************
5+
6+
To ease the development and testing of local packaging changes,
7+
development-quality DEB or RPM packages can be built with one of the following
8+
scripts on a build host which already has all system build dependencies
9+
installed:
10+
11+
.. code-block:: bash
12+
13+
./packages/brpm --distro=redhat # or --distro=suse to build an RPM
14+
./packages/bddeb -d # to build a DEB
15+
16+
OR if LXD is present, the full package build can be run in a container:
17+
18+
.. code-block:: bash
19+
20+
./tools/run-container ubuntu-daily:plucky --package --keep
21+
./tools/run-container rockylinux/9 --package --keep
22+
23+
24+
.. note::
25+
26+
meson support has not yet been added to the BSDs in :file:`tools/build-on-*bsd` or :file:`meson.build`.

doc/rtd/development/packaging.rst

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ Additional dependencies for systemd environments:
2828
- ``systemd-devel``
2929
- ``udev``
3030

31-
The full list of all package build-dependencies for a given
32-
distribution can be obtained by the following command:
31+
The full list of all package build dependencies for a given distribution can
32+
be obtained by the following command:
3333

3434
.. code-block:: bash
3535
36-
./tools/read-dependencies --system --distro=<your_distro_name>
36+
./tools/read-dependencies --requirements-file requirements.txt --requirements-file test-requirements.txt --system-pkg-names --system-pkg-names --distro=<your_distro_name>
3737
3838
3939
Manual build procedure
@@ -52,30 +52,7 @@ Steps to validate ``cloud-init`` package builds in a development environment:
5252
# List installed files
5353
find builddir/testinstall/
5454
55-
56-
Test builds of RPMs or DEBs
57-
---------------------------
58-
To ease the development and testing of local changes, development-quality DEB
59-
or RPM packages can be built with one of the following scripts on a build host
60-
which already has all system build dependencies installed:
61-
62-
.. code-block:: bash
63-
64-
./packages/brpm --distro=redhat # or --distro=suse to build an RPM
65-
./packages/bddeb -d # to build a DEB
66-
67-
OR if LXC is present, the full package build can be run in a container:
68-
69-
.. code-block:: bash
70-
71-
./tools/run-container ubuntu-daily:plucky --package --keep
72-
./tools/run-container rockylinux/9 --package --keep
73-
74-
75-
.. note::
76-
77-
meson support has not yet been added to the BSDs in :file:`tools/build-on-*bsd` or :file:`meson.build`.
78-
55+
See :ref:`package_testing` for more information package testing.
7956

8057
.. LINKS:
8158
.. _meson: https://mesonbuild.com/
File renamed without changes.

doc/rtd/howto/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,3 @@ How do I...?
2828
Report a bug <bugs.rst>
2929
Identify my datasource <identify_datasource.rst>
3030
Disable cloud-init <disable_cloud_init.rst>
31-
Test pre-release cloud-init on Ubuntu <ubuntu_test_prerelease.rst>

doc/rtd/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,10 @@ projects, contributions, suggestions, fixes and constructive feedback.
9898
Contributing overview <development/index.rst>
9999
Contribute to code <development/contribute_code.rst>
100100
Contribute to docs <development/contribute_docs.rst>
101+
Contribute to testing <development/contribute_testing.rst>
101102
Community <development/summit.rst>
102103
Downstream packaging <development/packaging.rst>
103104

104-
105105
.. LINKS
106106
.. include:: links.txt
107107
.. _Release schedule: https://discourse.ubuntu.com/t/2025-cloud-init-release-schedule/55534

0 commit comments

Comments
 (0)