Skip to content

Commit bd83c93

Browse files
committed
Update and clean readme
Change-Id: I8c875fd134fc2afcd6b79fa09239f5735a115366 Reviewed-by: Daniel Smith <[email protected]>
1 parent df15a80 commit bd83c93

File tree

1 file changed

+9
-24
lines changed

1 file changed

+9
-24
lines changed

README.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,14 @@
7171

7272
Building the Java Plugin
7373
* have a gerrit checkout and clone the plugin to plugins/gerrit-plugin-qt-workflow (we should add it as submodule when it's done)
74-
* run "bazel build plugins/gerrit-plugin-qt-workflow"
74+
* run "bazelisk build plugins/gerrit-plugin-qt-workflow"
7575
* the binary will be "bazel-genfiles/plugins/gerrit-plugin-qt-workflow/gerrit-plugin-qt-workflow.jar"
7676

7777
Building Gerrit
78-
* run "bazel build release"
78+
* run "bazelisk build release"
7979
* copy binary file to the gerrit site directory: "cp bazel-bin/release.war thedir/bin/gerrit.war"
8080

8181
Working with the local development environment
82-
* Setup database
83-
https://codereview.qt-project.org/Documentation/install.html#createdb
8482
* Init test site
8583
https://gerrit-review.googlesource.com/Documentation/dev-readme.html#init
8684
* Set access righs for test projects:
@@ -98,22 +96,18 @@
9896
ssh -p 29418 admin@localhost gerrit-plugin-qt-workflow staging-approve --branch master --build-id b001 --project JustTest --result pass
9997
ssh -p 29418 admin@localhost gerrit stream-events
10098
ssh -p 29418 admin@localhost gerrit index changes 17 26 27 28
101-
* useful Git commands
102-
git pull --recurse-submodules
103-
git clone ssh://admin@localhost:29418/arepo.git
104-
git push origin HEAD:refs/for/master
99+
* Fetching staging and builds refs to work area.
105100
git fetch -f origin refs/staging/*:refs/staging/*
106101
git fetch -f origin refs/builds/*:refs/builds/*
107-
git fetch origin
108-
git reset --hard origin/master
109102
* Running tests:
110-
bazel test --test_output=streamed //plugins/gerrit-plugin-qt-workflow:*
103+
bazelisk test --test_output=streamed //plugins/gerrit-plugin-qt-workflow:*
104+
* Running a single test, for example:
105+
bazelisk test --test_output=streamed //plugins/gerrit-plugin-qt-workflow:qtcodereview_tests --test_filter=singleChange_Defer_QtAbandon
111106
* Test coverage:
112107
install genhtml tool, for example: brew install lcov
113-
run: bazel coverage //plugins/gerrit-plugin-qt-workflow:*
114-
cd plugins/gerrit-plugin-qt-workflow
115-
./tools/coverage.sh thecoveragefile.dat
116-
=> html report available at ./coverage/index.html
108+
run: bazelisk coverage //plugins/gerrit-plugin-qt-workflow:*
109+
genhtml -o ./coveragedir --ignore-errors source thegeneratedcoveragefile.dat
110+
=> html report available at ./coveragedir/index.html
117111

118112
## Installation
119113

@@ -125,17 +119,8 @@
125119
rebuild with the patches. The plan is to upstream these changes.
126120

127121
Access rights:
128-
* FIXME: Stage/Unstage requires push permission to refs/staging/* branch - we should instead have an explicit staging right
129122
* Defer/Reopen requires same permissions as abandon
130123
* CI needs the permission to created references (refs/builds/*), push to branches (refs/heads/*) and
131124
force push to staging refs (refs/staging/*)
132125

133126
Copy static files into the site dir: cp gerrit-plugin-qt-workflow/static/* gerritsitedir/static/
134-
135-
## Open Items
136-
137-
* Events are needed for staged, integrating and deferred status changes
138-
* There is currently no rights management for when to show the staging button
139-
* In testing the staging branch was not created automatically
140-
* Are email notifications needed for deferred, reopened status changes?
141-
* automated tests for UI?

0 commit comments

Comments
 (0)