diff options
author | Jussi Pakkanen <jpakkane@gmail.com> | 2020-10-10 14:32:47 +0300 |
---|---|---|
committer | Daniel Mensinger <daniel@mensinger-ka.de> | 2020-10-10 22:14:34 +0200 |
commit | 7b1cc95c7f941b517a653f0d915e2b3bdacc3aa9 (patch) | |
tree | e32f4d3f9124954019a3e50090a77c63bdfdafe9 /docs/markdown | |
parent | f80dcb4f3366b0c699b5c8de046041fd0a781183 (diff) | |
download | meson-7b1cc95c7f941b517a653f0d915e2b3bdacc3aa9.zip meson-7b1cc95c7f941b517a653f0d915e2b3bdacc3aa9.tar.gz meson-7b1cc95c7f941b517a653f0d915e2b3bdacc3aa9.tar.bz2 |
Update wrap maintenance documentation. [skip ci]
Diffstat (limited to 'docs/markdown')
-rw-r--r-- | docs/markdown/Wrap-maintainer-tools.md | 17 | ||||
-rw-r--r-- | docs/markdown/Wrap-review-guidelines.md | 34 |
2 files changed, 32 insertions, 19 deletions
diff --git a/docs/markdown/Wrap-maintainer-tools.md b/docs/markdown/Wrap-maintainer-tools.md deleted file mode 100644 index 717d0d2..0000000 --- a/docs/markdown/Wrap-maintainer-tools.md +++ /dev/null @@ -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> -``` diff --git a/docs/markdown/Wrap-review-guidelines.md b/docs/markdown/Wrap-review-guidelines.md index 3e41a8d..389328b 100644 --- a/docs/markdown/Wrap-review-guidelines.md +++ b/docs/markdown/Wrap-review-guidelines.md @@ -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 +``` |