gplugin/gplugin

Add basic Convey instructions to HACKING
develop
2020-02-15, Richard Laager
d9fdcdb2b176
Parents a7dd676db7d8
Children 3feea9199e7e
Add basic Convey instructions to HACKING
1 files changed, 33 insertions(+), 3 deletions(-)
  • +33 -3
    HACKING.md
    • --- a/HACKING.md Sat Feb 15 21:12:25 2020 -0600
    +++ b/HACKING.md Sat Feb 15 21:14:07 2020 -0600
    @@ -43,9 +43,38 @@
    sudo update-alternatives --set clang-format /usr/bin/clang-format-9
    ```
    +## convey
    +
    +GPlugin uses [Convey][3] for CI. You can run the integration tests locally.
    +
    +To initially setup Convey, which requires Docker:
    +
    +1. Install Convey. You can use a pre-built binary from [convey's Downloads
    + page][4]; put that (or a symlink) in your `$PATH` named `convey`.
    + For now, avoid version 0.14.
    +2. Install Docker. On Debian systems, use: `sudo apt install docker.io`
    +3. Add yourself to the `docker` group. Adding yourself to a group does not
    + add that group to your existing session, so the first time you will need to
    + get a shell in that group with `newgrp docker` or by rebooting.
    +
    +To run all of the integration tests, run the "all" metaplan:
    +```
    +convey all
    +```
    +
    +To run a specific test/platform, run the plan directly:
    +```
    +convey alpine-edge-amd64
    +```
    +
    +To get a list of metaplans and their plans:
    +```
    +convey list metaplans
    +```
    +
    ## hgflow
    -GPlugin uses [hgflow][3] for development. All development takes place on the
    +GPlugin uses [hgflow][5] for development. All development takes place on the
    develop branch which leaves default to be a stable release clone. All long
    term feature/bug fix work should take place on a feature branch that when
    closed, gets merged to develop.
    @@ -56,7 +85,6 @@
    To add a feature please clone `https://keep.imfreedom.org/gplugin/gplugin`.
    Once you have your fork cloned and hgflow setup and installed, type:
    -
    ```
    hg flow feature start $NAME_OF_YOUR_FEATURE$
    ```
    @@ -67,4 +95,6 @@
    [1]: https://clang.llvm.org/docs/ClangFormat.html
    [2]: https://hg.mozilla.org/projects/nss/file/default/coreconf/precommit.clang-format.sh
    -[3]: https://hg.sr.ht/~wu/hgflow
    +[3]: https://bitbucket.org/rw_grim/convey
    +[4]: https://bitbucket.org/rw_grim/convey/downloads/
    +[5]: https://hg.sr.ht/~wu/hgflow