Commit 2c456364 authored by David Boddie's avatar David Boddie
Browse files

Add notes about librem5-base, gbp and GitLab CI

parent 57392a51
......@@ -18,6 +18,6 @@ Base Packages
The base packages on the phone are defined in the `librem5-base`_ repository, which is used to generate metapackages -- packages that are used to group packages into collections for convenient installation. The CI system `builds system images <Image Builds_>`_ that include some of these metapackages pre-installed.
To ensure that a package is installed, it needs to be included in one of the `librem5-base`_ metapackages.
To ensure that a package is installed, it needs to be included in one of the `librem5-base`_ metapackages or be a dependency of one of those metapackages.
.. include:: /links.txt
......@@ -86,6 +86,9 @@ Testing a New Component Locally
Before submitting a merge request to add a new component for the CI infrastructure to build, it is best to ensure that packages for the component can be built correctly. This is typically done on the developer's workstation by following the usual steps to build a Debian package.
For software hosted in Purism's GitLab infrastructure, it can also be helpful to use CI pipelines to build packages automatically. See the `librem5-user-docs repository`_ for an example CI recipe.
.. include:: /links.txt
.. _deb-build-jobs_merged: https://source.puri.sm/Librem5/deb-build-jobs/merge_requests?scope=all&utf8=%E2%9C%93&state=merged
.. _groovy_script: https://source.puri.sm/Librem5/deb-build-jobs/blob/master/jobs.groovy
.. _`librem5-user-docs repository`: https://source.puri.sm/Librem5/librem5-user-docs/blob/master/.gitlab-ci.yml
......@@ -22,7 +22,7 @@ This indicates the suite where the package will be published.
Tag the Release with a Signed Tag
---------------------------------
Each package that needs to be made available from the PureOS package repository must be generated from a commit that is tagged with a signed git tag by the developer.
Each package that needs to be made available from the PureOS package repository must be generated from a commit that is tagged with a signed git tag by the developer. You may find it useful to use `git-buildpackage`_ to perform this task and make sure that it is done in a consistent way.
Upstream Packaging
~~~~~~~~~~~~~~~~~~
......@@ -37,10 +37,15 @@ Here, ``phosh`` is the name of the package, as given in the ``debian/changelog``
phosh (0.1.0) amber-phone; urgency=medium
Ensure that the version numbers match and that the tag is prefixed with ``v`` both in the tag itself and in the message passed using the ``-m`` option.
Ensure that the version numbers match and that the tag is prefixed with ``v`` both in the tag itself and in the message passed using the ``-m`` option.
Publish the tag in the publicly available repository for the software so that the CI system can find it. This must be the same repository specified in the ``jobs.yml`` file in the `deb-build-jobs`_ repository. The CI system will pull the signed tag automatically.
Downstream Packaging
~~~~~~~~~~~~~~~~~~~~
This is currently described in the `Librem5 pureos amber-phone uploads`_ note.
Uploading Packages
------------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment