Add a new package
We will need to (optionally) create a project, then create a repository, reference it in the CI and finally update the documentation repository so the docs get built with that new package. Optionally, we can also create the necessary debian branches for the debian build deployment process to work. That’s not something immediately urgent when bootstraping a package though.
Create a project
Create a new Project (seen also as a
Tag) and fill in the form:
Fill in the “name” field (e.g.
Loader XYZ, …)
Additional hashtags should be filled in with easy to remember hashtags (e.g.
Add a small description about what the project is about
Create a repository
Create a new Git repository and fill in the form:
nameof the repository should be human readable (e.g.
callsignshould follow the current naming convention
short-nameshould be lower case and dash separated (e.g.
Tagsshould be filled with:
the first project/tag you created
Language-Python: Enable unit tests execution on commit
Has debian packaging branches: Activate debian builds in the CI
Sync to github: (optional) Activate mirroring sync to github
Add the staging area, click in order from
BUILDS(left menu) >
Edit staging> fill in
Staging Area URIwith https://forge.softwareheritage.org/source/staging.git
Finally, activate the repository
Add the repo on the swh-environment project
(Only if necessary)
Unless specified otherwise, the following commands need to run from the base directory
clone the new repository
git clone https://forge.softwareheritage.org/source/swh-my-new-repo.git
launch the command
bin/init-py-repoto initialize the repository with a project template
Edit the default content of the template (Example)
Configure your local pre-commit hook
grep -q pre-commit.com .git/hooks/pre-commit || pre-commit install
Declare the repository on the mr configuration
.mrconfigfile and declare the new repository (just duplicate one existing entry and adapt with the new package name)
Commit file modification (Example)
Install CI jobs
Setting up debian builds
As mentioned early in the introduction, this configuration can be delayed for when the package is actually ready to be deployed.
If you want to attend immedialy, follow through the Setting up the debian build documentation.
Documentation repository is located in the swh-docs repository.
Add the new package dependency in the top-level
Add the new package entry in
docs/index.rstwith a concise description of the package
:ref:`swh.my_new_repo <swh-my-new-repo>` short description of the repository ... # at the end of the index page swh.my_new_repo <swh-my-new-repo/index>
ensure this builds fine locally (e.g run tox, then make -C docs)
Then open a diff to advertise the new documentation entrypoints (Example)