Lugbot Quickstart

Steps to configure Lugbot

Configure your webhooks settings and add a webhook for @lugbot.

• Go to your repo's setting page: https://github.com/kresimir-coko/lugbot-test-repo/settings/hooks
• Click Add Webhook button
• Paste in this webhook url:
  https://a82ad12fac22.ngrok.io/hooks/github
• Switch Content type to: application/json
• Leave Secret blank.
• Under Which events would you like select Send me everything.
• Click Add webhook
• Leave Active setting with default.

.liferay/lugbot.yaml

Below is sample conetnts of a .liferay/lugbot.yaml file.

tasks:
  mode: pr
  upgrade:
    currentVersion: '6.2'
    upgradeVersion: '7.3'
    workspacePath: path/to/liferay-workspace/
    enableAll: true
  quality:
    categories:
    - BugPrevention
    - Performance

Using Lugbot

Prepare an upgrade branch

• Create a branch to process your upgrade.
• In this branch, add a file to the root of the repo: .liferay/lugbot.yaml. See [lugbot.yaml] section for details.
• Push upgrade branch to repository.
• Once upgrade branch is pushing, lugbot will begin processing the repository.

Lugbot workflow

• Once Lugbot sends pull requests, you can review, merge, or close those pull requests.
• Each branch that is sent by Lugbot will be named lugbot_<nameofupgrade>
• Lugbot will not rerun that particular "upgrade" if that branch is still available
• To get Lugbot to re-run a particular upgrade, you will need to close the PR and delete the remote branch
• If you would like Lugbot to re-run all of upgrade processing on your repo, do one of the following
  -- push a commit to your "upgrade" branch
  -- add any comment on this issue.

Lugbot commands

• You can communicate with Lugbot via this issue by typing a comment with lugbot: prefix.
• Below some available commands
  -- lugbot:help
  -- lugbot:run - Causes lugbot to process this repository and execute configured tasks in .liferay/lugbot.yaml
  -- lugbot:configExample