diff options
Diffstat (limited to 'docs/markdown/Adding-new-projects-to-wrapdb.md')
-rw-r--r-- | docs/markdown/Adding-new-projects-to-wrapdb.md | 53 |
1 files changed, 29 insertions, 24 deletions
diff --git a/docs/markdown/Adding-new-projects-to-wrapdb.md b/docs/markdown/Adding-new-projects-to-wrapdb.md index bbe945d..25fb61c 100644 --- a/docs/markdown/Adding-new-projects-to-wrapdb.md +++ b/docs/markdown/Adding-new-projects-to-wrapdb.md @@ -6,14 +6,17 @@ Each wrap repository has a master branch with only one initial commit and *no* wrap files. And that is the only commit ever made on that branch. -For every release of a project a new branch is created. The new branch is named after the -the upstream release number (e.g. `1.0.0`). This branch holds a wrap file for +For every release of a project a new branch is created. The new branch is named after the +the upstream release number (e.g. `1.0.0`). This branch holds a wrap file for this particular release. There are two types of wraps on WrapDB - regular wraps and wraps with Meson build definition patches. A wrap file in a repository on WrapDB must have a name `upstream.wrap`. -Wraps with Meson build definition patches work in much the same way as Debian: we take the unaltered upstream source package and add a new build system to it as a patch. These build systems are stored as Git repositories on GitHub. They only contain build definition files. You may also think of them as an overlay to upstream source. +Wraps with Meson build definition patches work in much the same way as Debian: +we take the unaltered upstream source package and add a new build system to it as a patch. +These build systems are stored as Git repositories on GitHub. They only contain build definition files. +You may also think of them as an overlay to upstream source. Whenever a new commit is pushed into GitHub's project branch, a new wrap is generated with an incremented version number. All the old releases remain unaltered. @@ -21,13 +24,15 @@ New commits are always done via GitHub merge requests and must be reviewed by someone other than the submitter. Note that your Git repo with wrap must not contain the subdirectory of the source -release. That gets added automatically by the service. You also must not commit +release. That gets added automatically by the service. You also must not commit any source code from the original tarball into the wrap repository. ## Choosing the repository name Wrapped subprojects are used much like external dependencies. Thus -they should have the same name as the upstream projects. +they should have the same name as the upstream projects. + +NOTE: Repo names must fully match this regexp: `[a-z0-9._]+`. If the project provides a pkg-config file, then the repository name should be the same as the pkg-config name. Usually this is the name of the @@ -36,16 +41,19 @@ however. As an example the libogg project's chosen pkg-config name is `ogg` instead of `libogg`, which is the reason why the repository is named plain `ogg`. -If there is no a pkg-config file, the name the project uses/promotes should be used, +If there is no a pkg-config file, the name the project uses/promotes should be used, lowercase only (Catch2 -> catch2). +If the project name is too generic or ambiguous (e.g. `benchmark`), +consider using `organization-project` naming format (e.g. `google-benchmark`). + ## How to contribute a new wrap If the project already uses Meson build system, then only a wrap file - `upstream.wrap` -should be provided. In other case a Meson build definition patch - a set of `meson.build` +should be provided. In other case a Meson build definition patch - a set of `meson.build` files - should be also provided. -### Request a new repository or branch +### Request a new repository Create an issue on the [wrapdb bug tracker](https://github.com/mesonbuild/wrapdb/issues) using *Title* and *Description* below as a template. @@ -61,6 +69,9 @@ version: <version_you_have_a_wrap_for> Wait until the new repository or branch is created. A link to the new repository or branch will be posted in a comment to this issue. +NOTE: Requesting a branch is not necessary. WrapDB maintainer can create the branch and +modify the PR accordingly if the project repository exists. + ### Add a new wrap First you need to fork the repository to your own page. @@ -80,28 +91,28 @@ git commit -a -m 'Add wrap files for libfoo-1.0.0' git push origin 1.0.0 ``` -Now you should create a pull request on GitHub. Remember to create it against the -correct branch rather than master (`1.0.0` branch in this example). GitHub should do +Now you should create a pull request on GitHub. Remember to create it against the +correct branch rather than master (`1.0.0` branch in this example). GitHub should do this automatically. +If the branch doesn't exist file a pull request against master. +WrapDB maintainers can fix it before merging. + ## What is done by WrapDB maintainers +[mesonwrap tools](Wrap-maintainer-tools.md) must be used for the tasks below. + ### Adding new project to the Wrap provider service Each project gets its own repo. It is initialized like this: ``` -git init -git add readme.txt -git add LICENSE.build -git commit -a -m 'Create project foobar' -git remote add origin <repo url> -git push -u origin master +mesonwrap new_repo --homepage=$HOMEPAGE --directory=$NEW_LOCAL_PROJECT_DIR $PROJECT_NAME ``` -Note that this is the *only* commit that will ever be made to master branch. All other commits are done to branches. +The command creates a new repository and uploads it to Github. -Repo names must fully match this regexp: `[a-z0-9._]+`. +`--version` flag may be used to create a branch immediately. ### Adding a new branch to an existing project @@ -129,12 +140,6 @@ to functionality. All such changes must be submitted to upstream. You may also host your own Git repo with the changes if you wish. The Wrap system has native support for Git subprojects. -## Creator script - -The WrapDB repository has a -[helper script](https://github.com/mesonbuild/mesonwrap/blob/master/mesonwrap.py) -to generate new repositories, verify them and update them. - ## Reviewing wraps See [Wrap review guidelines](Wrap-review-guidelines.md). |