bot-ci task overview

[fwalch]

This is a list of ideas for bot-ci improvements/changes.

Open (highest-priority first)

• Use h2h.py python script to generate help doc HTML instead of the old awk script
• Improve Git error handling: don't retry pushing when Github token is invalid, ...
• Post Windows installer to Releases (+ rework nightly description). Ref Windows: improvements neovim#5229
• Post macOS installer to Releases
• Set up clang-tidy builds. (addressed by Enable clint on all files, but ignore existing errors neovim#3174)
• generate report HTML template in neovim/neovim.github.io with placeholders instead of using fixed one in this repo
• Add labels instead of replacing them (ref [RFC] Change refs for joyent/libuv repo to libuv/libuv neovim#1562 (comment); https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue)
• automatically update Homebrew formula in neovim/homebrew-neovim with version/SHA from third-party/CMakeLists.txt in neovim/neovim
  • maybe update the version of neovim itself, using the latest commit from neovim/neovim?
• investigate generation of "permalinks" for clang report pages (e.g. link in [RFC] clang: Null pointer passed as an argument to a 'nonnull' parameter neovim#1090 doesn't work after new build)
  • With permalinks we could "suppress" clang scan-build warnings if needed.

On Hold

• From bot-ci task overview #12 (comment): replace sed with https://github.com/EricChiang/pup
• Update labels script to run on other repos (neovim/python-client, neovim/lua-client, bot-ci, ...)?
• build nightly from last working commit on neovim/neovim instead of using the latest commit: [RFC] Build nightly based on latest successful Travis build. #27
• update custom luarocks repo (http://luarocks.org/en/make-manifest) (Build fails with "Failed downloading https://rocks.moonscript.org/manifest" (~/.cache/luarocks owned by root user) neovim#1170 (comment))
• Modify travis-setup.sh script to accept an environment variable to force building dependencies instead of downloading them from neovim/deps (to test PRs such as [RFC] Update to libuv 1.0.1. neovim#1542, [RFC] build: disable dtrace support in libuv neovim#1545 before the next bot-ci run).
  • Can be done without modifying the script, e.g. [RDY] Small Travis-related improvements. neovim#1570.
• Include untagged commits in vimpatch report (Missing Vim patches neovim#1745 (comment), [RFC] vim-patch.sh: Add option to list missing Vim changesets. neovim#1781).
  • [justinmk] vim-patch.sh already covers this; the runtime patches get merged quickly so we don't really need them in the report (actually the vimpatch report may not be much useful since vim-patch.sh exists)

Done

• Travis improvements:
  • use Travis lifecycle: install dependencies, perform build, push if successful. Note: environment variables exported in a script are not accessible later on.
  • investigate where sudo: false can be used (ref [RFC] Travis: Use container-based infrastructure where possible. #47)
• Investigate using travis-setup.sh with source instead of eval.
• From [RFC] Add dependency rebuilding (32/64 bit). #20 (comment):
• parallel report building: add travis.yml build matrix with one entry for each report ([RFC] Build reports independently and in parallel. #13)
• parallel report building: modify publish-docs.sh to generate only one report and check out/push a specific subdirectory ([RFC] Build reports independently and in parallel. #13, [RDY] Rename build-reports to reports. doc#1)
• refactor "doc" scripts into independent scripts and common functions to get rid of publish-docs.sh ([RFC] Refactor into standalone build scripts. #14)
• better support local builds for testing purposes ([RFC] Refactor into standalone build scripts. #14)
• retrieve only necessary dependencies/repositories for each build type (e.g. update-doc-index doesn't even need neovim/neovim: [RFC] Install only necessary dependencies for each build type. #16)
• add user docu build ([RFC] Generate user documentation. #5)
• add coverity build type (refactor [WIP] Add coverity and rebuild-deps build types. #8: [RFC] Add coverity build type. #18 )
• add dependency rebuilding build type (refactor [WIP] Add coverity and rebuild-deps build types. #8: [RFC] Add dependency rebuilding (32/64 bit). #20)
• add nightly build type (push to Github releases: [RFC] Add nightly build. #25, ref Travis-ready build of Neovim neovim#1135)
• assign RFC/WIP/RDY tags to issues based on issue title (ref GitHub request for PR/Issue creator assignable labels. neovim#1409): [RFC] Auto-assign labels to PRs based on their title. #28
• push dependency (e.g. libuv) sources to neovim/deps for import to Launchpad & use in Ubuntu PPA (currently: https://code.launchpad.net/~neovim-ppa/neovim-ppa/neovim-deps): [RFC] Push dependency sources to neovim/deps. #57.

[justinmk]

Dunno if we'll need it, but just saw this on HN https://github.com/EricChiang/pup

I found jq great for JSON, would be great to have a similar tool for HTML.

[fwalch]

@justinmk That looks interesting, thanks! I don't have too much faith in the robustness of the current extract_* methods, so this could certainly improve things.

[justinmk]

Things we need on top of #28:

• check pull requests closed in the last N days and remove RFC/WIP/RDY tags
  • sample request: send_gh_api_request "repos/neovim/neovim/issues?state=closed&since=2014-11-13T00:00:00EST" (note that the since parameter is not available in the pulls/ handler, so we'll get a few issues in the response, but it's harmless)
• .... can't remember the other thing

[justinmk]

check pull requests closed in the last N days and remove RFC/WIP/RDY tags

Actually, looks like waffle automatically removed RDY with I closed a PR. So we probably don't need to add this to the script.

[justinmk]

Added a todo about switching to the python script instead of the awk script for HTML help. See also neovim/neovim.github.io#55 (comment)

[0x647262]

Investigate using travis-setup.sh with source instead of eval.

I assume this refers to: https://github.com/neovim/bot-ci/blob/master/scripts/travis-setup.sh#L26

On my machine:

 » /bin/luarocks path
export LUA_PATH='/home/krak-n/.luarocks/share/lua/5.3/?.lua;/home/krak-n/.luarocks/share/lua/5.3/?/init.lua;/usr/share/lua/5.3/?.lua;/usr/share/lua/5.3/?/init.lua;/usr/lib/lua/5.3/?.lua;/usr/lib/lua/5.3/?/init.lua;./?.lua;./?/init.lua'
export LUA_CPATH='/home/krak-n/.luarocks/lib/lua/5.3/?.so;/usr/lib/lua/5.3/?.so;/usr/lib/lua/5.3/loadall.so;./?.so'

If I am not mistaken that line can be shortened to (removing the eval):

"$(${NVIM_DEPS_PREFIX}/bin/luarocks path)"

Example on a local machine:

 » $(/bin/luarocks path)
 » echo $LUA_CPATH 
'/home/krak-n/.luarocks/lib/lua/5.3/?.so;/usr/lib/lua/5.3/?.so;/usr/lib/lua/5.3/loadall.so;./?.so'
 » echo $LUA_PATH 
'/home/krak-n/.luarocks/share/lua/5.3/?.lua;/home/krak-n/.luarocks/share/lua/5.3/?/init.lua;/usr/share/lua/5.3/?.lua;/usr/share/lua/5.3/?/init.lua;/usr/lib/lua/5.3/?.lua;/usr/lib/lua/5.3/?/init.lua;./?.lua;./?/init.lua'
 » 

I'll open a PR shortly.

EDIT: https://github.com/neovim/bot-ci/blob/master/ci/common/common.sh#L10 might be worth looking over as well...

[justinmk]

@Krakn Help on bot-ci is really appreciated!

Investigate using travis-setup.sh with source instead of eval.

It's referring to the before_install line at https://github.com/neovim/bot-ci#generated-builds

However the change you made is probably ok.

[0x647262]

@justinmk It was reviewed and the changes I made broke things. :(

If I am not mistaken, at the end of the travis-setup.sh file, we could change the call to _call_function :

_call_function "${1}"

Which would allow you to:

curl -Ss "${URL}" | bash -s -- 'nightly-x64'

or

bash <(curl -Ss "${URL}") 'nightly-x64'

Though I am not entirely sure what benefits are gained by moving from eval to piping to bash...

@ZyX-I Thoughts?

EDIT: Missed a closing )

[ZyX-I]

If I am not mistaken that line can be shortened to (removing the eval):

"$(${NVIM_DEPS_PREFIX}/bin/luarocks path)"
Example on a local machine:

 » $(/bin/luarocks path)
 » echo $LUA_CPATH 
'/home/krak-n/.luarocks/lib/lua/5.3/?.so;/usr/lib/lua/5.3/?.so;/usr/lib/lua/5.3/loadall.so;./?.so'
 » echo $LUA_PATH 
'/home/krak-n/.luarocks/share/lua/5.3/?.lua;/home/krak-n/.luarocks/share/lua/5.3/?/init.lua;/usr/share/lua/5.3/?.lua;/usr/share/lua/5.3/?/init.lua;/usr/lib/lua/5.3/?.lua;/usr/lib/lua/5.3/?/init.lua;./?.lua;./?/init.lua'
 » 

I'll open a PR shortly.

I see why you thought PR might work, but $(foo) and "$(foo)" are different things: the first from “on the local machine” does somewhat work because it does do argument splititng, but this has its own problems:

1. Right in your example you see that echo $LUA_PATH returns '…'. This is not OK, this indicates that ' were prepended to the first and appended to the last paths, proper variables must not have the quotes as they are part of the shell syntax and not variable values and echo does not do quoting.
2. This still is not going to work with paths with spaces.

The second as I said in that PR tries to execute the entire string as a single command name. Be careful with such tests.

---

As for last question: the first variant is going to work, the second variant is using bashism and I am not sure whether travis uses bash and not dash to execute scripts. And it is missing closing parenthesis.

[ZyX-I]

Benefits of piped version are rather minor: a bit faster and a bit less memory consuming due to bash being able to start parsing (and, not sure, but AFAIR executing as well) script before it is fully downloaded, but you would not normally notice that and it will be even less noticeable should the whole script arrive in one packet.

[0x647262]

Investigate using travis-setup.sh with source instead of eval.

In regards specifially to source, I found the following article: https://access.redhat.com/solutions/34842

Building off of ZyX-I's last comment: I would say it is safe to leave that eval alone, as there seems to be little benefit moving to a piped version.

@fwalch If no one else has an issue with it, I think we can check that task off of the list.

[justinmk]

I've created separate issues for the remaining items here.