Update wrap maintenance documentation. [skip ci]

pull/7828/head
Jussi Pakkanen 4 years ago committed by Daniel Mensinger
parent f80dcb4f33
commit 7b1cc95c7f
  1. 17
      docs/markdown/Wrap-maintainer-tools.md
  2. 34
      docs/markdown/Wrap-review-guidelines.md
  3. 1
      docs/sitemap.txt

@ -1,17 +0,0 @@
# Wrap maintainer tools
The [mesonwrap repository](https://github.com/mesonbuild/mesonwrap) provides tools
to maintain the WrapDB. Read-only features such can be used by anyone without Meson admin rights.
## Personal access token
Some tools require access to the Github API.
A [personal access token](https://github.com/settings/tokens) may be required
if the freebie Github API quota is exhausted. `public_repo` scope is required
for write operations.
```
$ cat ~/.config/mesonwrap.ini
[mesonwrap]
github_token = <github token>
```

@ -7,8 +7,25 @@ package is rejected. What should be done will be determined on a
case-by-case basis. Similarly meeting all these requirements does not
guarantee that the package will get accepted. Use common sense.
The review process is partially automated by the [mesonwrap](Wrap-maintainer-tools.md)
`review` tool.
## Setting up the tools
The [mesonwrap repository](https://github.com/mesonbuild/mesonwrap) provides tools
to maintain the WrapDB. Read-only features such can be used by anyone without Meson admin rights.
## Personal access token
Some tools require access to the Github API.
A [personal access token](https://github.com/settings/tokens) may be required
if the freebie Github API quota is exhausted. `public_repo` scope is required
for write operations.
```
$ cat ~/.config/mesonwrap.ini
[mesonwrap]
github_token = <github token>
```
## Reviewing code
```
mesonwrap review zlib --pull-request=1 [--approve]
@ -34,3 +51,16 @@ Encourage wrap readability. Use your own judgement.
If the code looks good use the `--approve` flag to merge it.
The tool automatically creates a release.
If you need to create a release manually (because, for example, a MR
was merged by hand), the command to do it is the following:
```shell
mesonwrap publish reponame version
```
An example invocation would look like this:
```shell
mesonwrap publish expat 2.2.9
```

@ -74,7 +74,6 @@ index.md
Adding-new-projects-to-wrapdb.md
Using-the-WrapDB.md
Using-wraptool.md
Wrap-maintainer-tools.md
Wrap-best-practices-and-tips.md
Wrap-review-guidelines.md
Shipping-prebuilt-binaries-as-wraps.md

Loading…
Cancel
Save