51 |
52 | ## :money_with_wings: Sponsoring
53 |
54 | Using Kodiak for your commercial project?
55 |
56 | [Support Kodiak with GitHub Sponsors](https://github.com/sponsors/chdsbd) to help cover server costs and support development.
57 |
58 | ## Contributing
59 |
60 | Feel free to file feature requests, bug reports, help requests through the issue tracker.
61 |
62 | If you'd like to add a feature, fix a bug, update the docs, etc, take a peek at our [contributing guide](https://kodiakhq.com/docs/contributing).
63 |
64 | ## Project Layout
65 |
66 | This repository contains multiple services that make up Kodiak. The GitHub App which receives webhook events from GitHub and operates of pull requests is stored at `bot/`. The web API powering the Kodiak dashboard (WIP) is stored at `web_api/` and the Kodiak dashboard frontend (WIP) that talks to the web api is stored at `web_ui/`.
67 |
--------------------------------------------------------------------------------
/assets/design.dot:
--------------------------------------------------------------------------------
1 | digraph Kodiak {
2 |
3 | "GitHub"[shape=doublecircle]
4 |
5 | "GitHub" -> "HTTP Webhook"[label="HTTP events", weight=0]
6 |
7 |
8 | subgraph cluster_kodiak {
9 | label = "Kodiak"
10 |
11 | "HTTP Webhook" -> Redis[label="write event to queue", weight=0]
12 | Redis[shape=cylinder]
13 |
14 | "Repo Queue Worker" -> Redis [label="pull off mergeable\n PRs and merge"]
15 | "Repo Queue Worker" -> "GitHub"
16 | "Async Worker" -> "GitHub"
17 |
18 | "Async Worker" -> Redis[label="write any mergeable PRs\nto per repo queue"]
19 |
20 | "Event Queue Worker" -> Redis[label="Left blocking pop \nfrom event queue"]
21 | "Event Queue Worker" -> "Async Worker"[style="dashed", label="create async task \nfor each event"]
22 | }
23 |
24 | }
25 |
--------------------------------------------------------------------------------
/assets/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/chdsbd/kodiak/0065e640d6febdb08ea236f459c125990fd9d9cf/assets/logo.png
--------------------------------------------------------------------------------
/bot/.coveragerc:
--------------------------------------------------------------------------------
1 | [run]
2 | omit =
3 | .venv/*
4 | venv/*
5 | env/*
6 | .env/*
7 |
--------------------------------------------------------------------------------
/bot/.dockerignore:
--------------------------------------------------------------------------------
1 | .git
2 | **/*.pyc
3 | **/__pycache__/
4 | .venv/
5 | Dockerfile
6 | *.pem
7 | *_cache/
8 | assets/
9 | .vscode/
10 | pip-wheel-metadata/
11 | *egg-info/
12 | docs/
13 | .github
14 | .circleci
15 |
--------------------------------------------------------------------------------
/bot/.python-version:
--------------------------------------------------------------------------------
1 | 3.7.13
2 |
--------------------------------------------------------------------------------
/bot/.vscode/extensions.json:
--------------------------------------------------------------------------------
1 | {
2 | "recommendations": ["ms-python.python"]
3 | }
--------------------------------------------------------------------------------
/bot/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "python.defaultInterpreterPath": ".venv/bin/python",
3 | "python.formatting.provider": "black",
4 | "editor.formatOnSave": true,
5 | "editor.codeActionsOnSave": {
6 | "source.organizeImports": true
7 | },
8 | "python.linting.mypyEnabled": true,
9 | "python.testing.pytestArgs": ["kodiak"],
10 | "python.testing.unittestEnabled": false,
11 | "python.testing.pytestEnabled": true,
12 | "python.linting.flake8Enabled": true,
13 | "python.linting.pylintEnabled": true
14 | }
15 |
--------------------------------------------------------------------------------
/bot/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM python:3.7@sha256:6eaf19442c358afc24834a6b17a3728a45c129de7703d8583392a138ecbdb092
2 |
3 | RUN set -ex && mkdir -p /var/app
4 |
5 | RUN apt-get update && apt-get install -y supervisor
6 |
7 | RUN mkdir -p /var/log/supervisor
8 |
9 | # use cryptography version for poetry that doesn't require Rust
10 | RUN python3 -m pip install cryptography===37.0.4
11 | RUN python3 -m pip install poetry===1.1.13
12 |
13 | RUN poetry config virtualenvs.in-project true
14 |
15 | COPY supervisord.conf /etc/supervisor/conf.d/supervisord.conf
16 |
17 | WORKDIR /var/app
18 |
19 | COPY pyproject.toml poetry.lock /var/app/
20 |
21 | # install deps
22 | RUN poetry install
23 |
24 | COPY . /var/app
25 |
26 | # workaround for: https://github.com/sdispater/poetry/issues/1123
27 | RUN rm -rf /var/app/pip-wheel-metadata/
28 |
29 | # install cli
30 | RUN poetry install
31 |
32 | CMD ["/usr/bin/supervisord"]
33 |
--------------------------------------------------------------------------------
/bot/README.md:
--------------------------------------------------------------------------------
1 | # Kodiak GitHub App
2 |
3 | The Kodiak GitHub App receives webhook requests from GitHub and acts on GitHub pull requests.
4 |
5 | ## Dev
6 |
7 | The follow shows how to run commands for testing and development. For information on creating an GitHub App for testing, please see
40 | {config_escaped}
41 |
42 |
43 | ## configuration error message
44 |
45 | {error_escaped}
46 |
47 |
48 | ## notes
49 | - Check the Kodiak docs for setup information at https://kodiakhq.com/docs/quickstart.
50 | - A configuration reference is available at https://kodiakhq.com/docs/config-reference.
51 | - Full examples are available at https://kodiakhq.com/docs/recipes
52 | """
53 | )
54 |
55 |
56 | def get_markdown_for_paywall() -> str:
57 | return format(
58 | """\
59 | You can start a 30 day trial or update your subscription on the Kodiak dashboard at https://app.kodiakhq.com.
60 |
61 | Kodiak is free to use on public repositories, but requires a subscription to use with private repositories.
62 |
63 | See the [Kodiak docs](https://kodiakhq.com/docs/billing) for more information about free trials and subscriptions.
64 | """
65 | )
66 |
67 |
68 | def get_markdown_for_push_allowance_error(*, branch_name: str) -> str:
69 | return format(
70 | f"""\
71 | Your branch protection setting for `{branch_name}` has "Restrict who can push to matching branches" enabled. You must allow Kodiak to push to this branch for Kodiak to merge pull requests.
72 |
73 | See the Kodiak troubleshooting docs for more information: https://kodiakhq.com/docs/troubleshooting#restricting-pushes
74 | """
75 | )
76 |
77 |
78 | class APICallRetry(Protocol):
79 | @property
80 | def api_name(self) -> str:
81 | ...
82 |
83 | @property
84 | def http_status(self) -> str:
85 | ...
86 |
87 | @property
88 | def response_body(self) -> str:
89 | ...
90 |
91 |
92 | def get_markdown_for_api_call_errors(*, errors: Sequence[APICallRetry]) -> str:
93 | formatted_errors = "\n".join(
94 | f"- API call {error.api_name!r} failed with HTTP status {error.http_status!r} and response: {error.response_body!r}"
95 | for error in errors
96 | )
97 | return format(
98 | f"""\
99 | Errors encountered when contacting GitHub API.
100 |
101 | {formatted_errors}
102 | """
103 | )
104 |
--------------------------------------------------------------------------------
/bot/kodiak/queries/commits.py:
--------------------------------------------------------------------------------
1 | from typing import Any, Dict, List, Optional
2 |
3 | import pydantic
4 | import structlog
5 |
6 | logger = structlog.get_logger()
7 |
8 |
9 | class CommitConnection(pydantic.BaseModel):
10 | totalCount: int
11 |
12 |
13 | class User(pydantic.BaseModel):
14 | databaseId: Optional[int]
15 | login: str
16 | name: Optional[str]
17 | type: str
18 |
19 | def __hash__(self) -> int:
20 | # defining a hash method allows us to deduplicate CommitAuthors easily.
21 | return hash(self.databaseId) + hash(self.login) + hash(self.name)
22 |
23 |
24 | class GitActor(pydantic.BaseModel):
25 | user: Optional[User]
26 |
27 |
28 | class Commit(pydantic.BaseModel):
29 | parents: CommitConnection
30 | author: Optional[GitActor]
31 |
32 |
33 | class PullRequestCommit(pydantic.BaseModel):
34 | commit: Commit
35 |
36 |
37 | class PullRequestCommitConnection(pydantic.BaseModel):
38 | nodes: Optional[List[PullRequestCommit]]
39 |
40 |
41 | class PullRequest(pydantic.BaseModel):
42 | commitHistory: PullRequestCommitConnection
43 |
44 |
45 | def get_commits(*, pr: Dict[str, Any]) -> List[Commit]:
46 | """
47 | Extract the commit authors from the pull request commits.
48 | """
49 | # we use a dict as an ordered set.
50 | try:
51 | pull_request = PullRequest.parse_obj(pr)
52 | except pydantic.ValidationError:
53 | logger.exception("problem parsing commit authors")
54 | return []
55 | nodes = pull_request.commitHistory.nodes
56 | if not nodes:
57 | return []
58 | return [node.commit for node in nodes]
59 |
--------------------------------------------------------------------------------
/bot/kodiak/redis_client.py:
--------------------------------------------------------------------------------
1 | import redis.asyncio as redis
2 |
3 | import kodiak.app_config as conf
4 |
5 |
6 | def create_connection() -> "redis.Redis[bytes]":
7 | redis_db = 0
8 | try:
9 | redis_db = int(conf.REDIS_URL.database)
10 | except ValueError:
11 | pass
12 |
13 | return redis.Redis(
14 | host=conf.REDIS_URL.hostname or "localhost",
15 | port=conf.REDIS_URL.port or 6379,
16 | username=conf.REDIS_URL.username,
17 | password=conf.REDIS_URL.password,
18 | ssl=conf.REDIS_URL.scheme == "rediss",
19 | db=redis_db,
20 | socket_keepalive=True,
21 | socket_timeout=conf.REDIS_SOCKET_TIMEOUT_SEC,
22 | socket_connect_timeout=conf.REDIS_SOCKET_CONNECT_TIMEOUT_SEC,
23 | health_check_interval=True,
24 | )
25 |
26 |
27 | redis_bot = create_connection()
28 | redis_web_api = create_connection()
29 |
--------------------------------------------------------------------------------
/bot/kodiak/schemas.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | from typing import Any, Dict
4 |
5 | import pydantic
6 |
7 |
8 | class RawWebhookEvent(pydantic.BaseModel):
9 | event_name: str
10 | payload: Dict[str, Any]
11 |
--------------------------------------------------------------------------------
/bot/kodiak/test/fixtures/config/v1-default.toml:
--------------------------------------------------------------------------------
1 | # configuration with all defaults set
2 | version = 1 # required
3 |
4 | [merge]
5 | automerge_label = "automerge"
6 | require_automerge_label = true
7 | # this setting is for snapshot testing purposes. This gets replaced with the
8 | # `WIP:.*` default regex in evaluation.py
9 | blacklist_title_regex = ":::|||kodiak|||internal|||reserved|||:::"
10 | blacklist_labels = []
11 | delete_branch_on_merge = false
12 | block_on_reviews_requested = false
13 | notify_on_conflict = true
14 | optimistic_updates = true
15 | dont_wait_on_status_checks = []
16 | update_branch_immediately = false
17 | prioritize_ready_to_merge = false
18 | do_not_merge = false
19 |
20 | [merge.message]
21 | title = "github_default"
22 | body = "github_default"
23 | include_pr_number = true
24 | body_type = "markdown"
25 | strip_html_comments = false
26 |
27 | [update]
28 | always = false
29 | require_automerge_label = true
30 |
31 | [approve]
32 | auto_approve_usernames = []
33 | auto_approve_labels = []
34 |
--------------------------------------------------------------------------------
/bot/kodiak/test/fixtures/config/v1-opposite.1.toml:
--------------------------------------------------------------------------------
1 | # configuration with all settings changed from defaults
2 | version = 1 # required
3 | app_id = 12345 # default: None
4 |
5 | [merge]
6 | automerge_label = "mergeit!" # default: "automerge"
7 | require_automerge_label = false # default: true
8 | blacklist_title_regex = "" # default: "^WIP:.*"
9 | blacklist_labels = ["wip", "block-merge"] # default: []
10 | method = "squash" # default: first valid merge method in list `"merge"`, `"squash"`, `"rebase"`
11 | delete_branch_on_merge = true # default: false
12 | block_on_reviews_requested = true # default: false
13 | notify_on_conflict = false # default: true
14 | optimistic_updates = false # default: true
15 | dont_wait_on_status_checks = ["ci/circleci: deploy"] # default: []
16 | update_branch_immediately = true
17 | prioritize_ready_to_merge = true
18 | do_not_merge = true
19 |
20 | [merge.message]
21 | title = "pull_request_title" # default: "github_default"
22 | body = "pull_request_body" # default: "github_default"
23 | include_pr_number = false # default: true
24 | body_type = "plain_text" # default: "markdown"
25 | strip_html_comments = true # default: false
26 |
27 | [update]
28 | always = true
29 | require_automerge_label = false
30 |
31 | [approve]
32 | auto_approve_usernames = ["dependabot"] # default: []
33 | auto_approve_labels = ["autoapprove"] # default: []
34 |
--------------------------------------------------------------------------------
/bot/kodiak/test/fixtures/config/v1-opposite.2.toml:
--------------------------------------------------------------------------------
1 | # configuration with all settings changed from defaults
2 | version = 1 # required
3 | app_id = 12345 # default: None
4 |
5 | [merge]
6 | automerge_label = "mergeit!" # default: "automerge"
7 | require_automerge_label = false # default: true
8 | blacklist_title_regex = "" # default: "^WIP:.*"
9 | blacklist_labels = ["wip", "block-merge"] # default: []
10 | method = "squash" # default: first valid merge method in list `"merge"`, `"squash"`, `"rebase"`
11 | delete_branch_on_merge = true # default: false
12 | block_on_reviews_requested = true # default: false
13 | notify_on_conflict = false # default: true
14 | optimistic_updates = false # default: true
15 | dont_wait_on_status_checks = ["ci/circleci: deploy"] # default: []
16 | update_branch_immediately = true
17 | prioritize_ready_to_merge = true
18 | do_not_merge = true
19 |
20 | [merge.message]
21 | title = "pull_request_title" # default: "github_default"
22 | body = "empty" # default: "github_default"
23 | include_pr_number = false # default: true
24 | body_type = "plain_text" # default: "markdown"
25 | strip_html_comments = true # default: false
26 |
27 | [update]
28 | always = true
29 | require_automerge_label = false
30 |
31 | [approve]
32 | auto_approve_usernames = ["dependabot"] # default: []
33 | auto_approve_labels = ["autoapprove"] # default: []
34 |
--------------------------------------------------------------------------------
/bot/kodiak/test/fixtures/config_utils/pydantic-error.md:
--------------------------------------------------------------------------------
1 | You have an invalid Kodiak configuration file.
2 |
3 | ## configuration file
4 | > config_file_expression: master:.kodiak.toml
5 | > line count: 1
6 |
7 | 8 | version = 12 9 |10 | 11 | ## configuration error message 12 |
13 | # pretty
14 | 1 validation error for V1
15 | version
16 | Version must be `1` (type=value_error.invalidversion)
17 |
18 |
19 | # json
20 | [
21 | {
22 | "loc": [
23 | "version"
24 | ],
25 | "msg": "Version must be `1`",
26 | "type": "value_error.invalidversion"
27 | }
28 | ]
29 |
30 |
31 | ## notes
32 | - Check the Kodiak docs for setup information at https://kodiakhq.com/docs/quickstart.
33 | - A configuration reference is available at https://kodiakhq.com/docs/config-reference.
34 | - Full examples are available at https://kodiakhq.com/docs/recipes
35 |
36 |
37 | If you need help, you can open a GitHub issue, check the docs, or reach us privately at support@kodiakhq.com.
38 |
39 | [docs](https://kodiakhq.com/docs/troubleshooting) | [dashboard](https://app.kodiakhq.com) | [support](https://kodiakhq.com/help)
40 |
41 |
--------------------------------------------------------------------------------
/bot/kodiak/test/fixtures/config_utils/toml-error.md:
--------------------------------------------------------------------------------
1 | You have an invalid Kodiak configuration file.
2 |
3 | ## configuration file
4 | > config_file_expression: master:.kodiak.toml
5 | > line count: 1
6 |
7 | 8 | [[[ version = 12 9 |10 | 11 | ## configuration error message 12 |
13 | TomlDecodeError('Key group not on a line by itself. (line 1 column 1 char 0)')
14 |
15 |
16 | ## notes
17 | - Check the Kodiak docs for setup information at https://kodiakhq.com/docs/quickstart.
18 | - A configuration reference is available at https://kodiakhq.com/docs/config-reference.
19 | - Full examples are available at https://kodiakhq.com/docs/recipes
20 |
21 |
22 | If you need help, you can open a GitHub issue, check the docs, or reach us privately at support@kodiakhq.com.
23 |
24 | [docs](https://kodiakhq.com/docs/troubleshooting) | [dashboard](https://app.kodiakhq.com) | [support](https://kodiakhq.com/help)
25 |
26 |
--------------------------------------------------------------------------------
/bot/kodiak/test_config_utils.py:
--------------------------------------------------------------------------------
1 | from pathlib import Path
2 |
3 | from kodiak.config import V1
4 | from kodiak.messages import get_markdown_for_config
5 |
6 |
7 | def load_config_fixture(fixture_name: str) -> Path:
8 | return Path(__file__).parent / "test" / "fixtures" / "config_utils" / fixture_name
9 |
10 |
11 | def test_get_markdown_for_config_pydantic_error() -> None:
12 | config = "version = 12"
13 | error = V1.parse_toml(config)
14 | assert not isinstance(error, V1)
15 | markdown = get_markdown_for_config(
16 | error, config_str=config, git_path="master:.kodiak.toml"
17 | )
18 | assert markdown == load_config_fixture("pydantic-error.md").read_text()
19 |
20 |
21 | def test_get_markdown_for_config_toml_error() -> None:
22 | config = "[[[ version = 12"
23 | error = V1.parse_toml(config)
24 | assert not isinstance(error, V1)
25 | markdown = get_markdown_for_config(
26 | error, config_str=config, git_path="master:.kodiak.toml"
27 | )
28 | assert markdown == load_config_fixture("toml-error.md").read_text()
29 |
--------------------------------------------------------------------------------
/bot/kodiak/test_event_handlers.py:
--------------------------------------------------------------------------------
1 | from kodiak.queue import get_branch_name
2 |
3 |
4 | def test_get_branch_name() -> None:
5 | assert get_branch_name("refs/heads/master") == "master"
6 | assert (
7 | get_branch_name("refs/heads/master/refs/heads/123") == "master/refs/heads/123"
8 | )
9 | assert get_branch_name("refs/tags/v0.1.0") is None
10 |
--------------------------------------------------------------------------------
/bot/kodiak/test_events.py:
--------------------------------------------------------------------------------
1 | from pathlib import Path
2 |
3 | import pytest
4 | from pydantic import BaseModel
5 |
6 | from kodiak import events
7 |
8 | # A mapping of all events to their corresponding fixtures. Any new event must
9 | # register themselves here for testing.
10 | MAPPING = (
11 | ("check_run", events.CheckRunEvent),
12 | ("pull_request", events.PullRequestEvent),
13 | ("pull_request_review", events.PullRequestReviewEvent),
14 | ("pull_request_review_thread", events.PullRequestReviewThreadEvent),
15 | ("status", events.StatusEvent),
16 | ("push", events.PushEvent),
17 | )
18 |
19 |
20 | @pytest.mark.parametrize("event_name, schema", MAPPING)
21 | def test_event_parsing(event_name: str, schema: BaseModel) -> None:
22 | for fixture_path in (
23 | Path(__file__).parent / "test" / "fixtures" / "events" / event_name
24 | ).rglob("*.json"):
25 | schema.parse_file(fixture_path)
26 |
--------------------------------------------------------------------------------
/bot/kodiak/test_queue.py:
--------------------------------------------------------------------------------
1 | import pytest
2 |
3 | from kodiak.queue import installation_id_from_queue
4 |
5 |
6 | @pytest.mark.parametrize(
7 | "queue_name, expected_installation_id",
8 | (
9 | ("merge_queue:11256551.sbdchd/squawk/main.test.foo", "11256551"),
10 | ("merge_queue:11256551.sbdchd/squawk", "11256551"),
11 | ("merge_queue:11256551.sbdchd/squawk:repo/main:test.branch", "11256551"),
12 | ("webhook:11256551", "11256551"),
13 | ("", ""),
14 | ),
15 | )
16 | def test_installation_id_from_queue(
17 | queue_name: str, expected_installation_id: str
18 | ) -> None:
19 | """
20 | We should gracefully parse an installation id from the queue name
21 | """
22 | assert installation_id_from_queue(queue_name) == expected_installation_id
23 |
--------------------------------------------------------------------------------
/bot/kodiak/test_text.py:
--------------------------------------------------------------------------------
1 | import pytest
2 |
3 | from kodiak.text import strip_html_comments_from_markdown
4 |
5 |
6 | @pytest.mark.parametrize(
7 | "original,stripped",
8 | [
9 | (
10 | """\
11 | Non dolor velit vel quia mollitia. Placeat cumque a deleniti possimus.
12 |
13 | Totam dolor [exercitationem laborum](https://numquam.com)
14 |
15 |
22 | """,
23 | """\
24 | Non dolor velit vel quia mollitia. Placeat cumque a deleniti possimus.
25 |
26 | Totam dolor [exercitationem laborum](https://numquam.com)
27 |
28 |
29 | """,
30 | ),
31 | (
32 | 'Non dolor velit vel quia mollitia.\r\n\r\nVoluptates nulla tempora.\r\n\r\n',
33 | "Non dolor velit vel quia mollitia.\n\nVoluptates nulla tempora.\n\n",
34 | ),
35 | ("hello world", "hello world"),
36 | (
37 | "hello hello
world", 38 | "hellohello
world", 39 | ), 40 | ( 41 | "hellohello
world", 42 | "hellohello
world", 43 | ), 44 | ( 45 | """\ 46 | this is an example comment message with a comment from a PR template 47 | 48 | 55 | """, 56 | """\ 57 | this is an example comment message with a comment from a PR template 58 | 59 | 60 | """, 61 | ), 62 | ("🏷️", "🏷️"), 63 | ], 64 | ) 65 | def test_strip_html_comments_from_markdown(original: str, stripped: str) -> None: 66 | assert strip_html_comments_from_markdown(original) == stripped 67 | -------------------------------------------------------------------------------- /bot/kodiak/test_utils.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import sys 3 | from typing import TypeVar 4 | 5 | T = TypeVar("T") 6 | 7 | # some change happened in Python 3.8 to eliminate the need for wrapping mock 8 | # results. 9 | if sys.version_info < (3, 8): 10 | 11 | def wrap_future(x: T) -> "asyncio.Future[T]": 12 | fut: "asyncio.Future[T]" = asyncio.Future() 13 | fut.set_result(x) 14 | return fut 15 | 16 | 17 | else: 18 | 19 | def wrap_future(x: T) -> "T": 20 | return x 21 | -------------------------------------------------------------------------------- /bot/kodiak/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chdsbd/kodiak/0065e640d6febdb08ea236f459c125990fd9d9cf/bot/kodiak/tests/__init__.py -------------------------------------------------------------------------------- /bot/kodiak/tests/dependencies/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chdsbd/kodiak/0065e640d6febdb08ea236f459c125990fd9d9cf/bot/kodiak/tests/dependencies/__init__.py -------------------------------------------------------------------------------- /bot/kodiak/tests/dependencies/pull_requests/update-major-github_action.txt: -------------------------------------------------------------------------------- 1 | chore(deps): update codecov/codecov-action action to v2 2 | [](https://renovatebot.com) 3 | 4 | This PR contains the following updates: 5 | 6 | | Package | Type | Update | Change | 7 | |---|---|---|---| 8 | | [codecov/codecov-action](https://togithub.com/codecov/codecov-action) | action | major | `v1` -> `v2` | 9 | 10 | --- 11 | 12 | ### Release Notes 13 | 14 |
15 |
16 | The pull request activity chart shows the number of pull requests opened, closed, and merged per day.
17 |
18 | 
19 |
20 | The Kodiak activity chart shows the number of pull requests merged by Kodiak per day.
21 |
22 | 
23 |
24 | All merge queues with pull requests are displayed at the bottom of the activity page.
25 |
26 | 
27 |
28 | ## Usage & Billing
29 |
30 | The usage and billing page displays trial and subscription information. You can start a trial or subscription via this page, update billing details and view subscription usage information.
31 |
32 | See the [billing docs](./billing.md) for information about starting a trial or modifying a subscription.
33 |
34 | 
35 |
36 | Seat license usage information is available at the bottom of the "Usage & Billing" page.
37 | 
38 |
--------------------------------------------------------------------------------
/docs/docs/quickstart.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: quickstart
3 | title: Quick Start
4 | sidebar_label: Quick Start
5 | ---
6 |
7 | 1. Install [the GitHub app](https://github.com/marketplace/kodiakhq#pricing-and-setup)
8 |
9 | 2. Create a `.kodiak.toml` file in the root of your repository with the following contents
10 |
11 | ```toml
12 | # .kodiak.toml
13 | # Minimal config. version is the only required field.
14 | version = 1
15 | ```
16 |
17 | 3. Configure [GitHub branch protection](https://help.github.com/en/articles/configuring-protected-branches). Setup [required status checks](https://docs.github.com/en/github/administering-a-repository/enabling-required-status-checks) to prevent failing PRs from being merged.
18 |
19 | 4. Create an automerge label (default: "automerge")
20 |
21 | 5. Start auto merging PRs with Kodiak
22 |
23 | Label your PRs with your `automerge` label and let Kodiak do the rest! 🎉
24 |
25 | If you have any questions please review [our help page](/help).
26 |
--------------------------------------------------------------------------------
/docs/docs/sponsoring.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: sponsoring
3 | title: 💸 Sponsoring
4 | sidebar_label: Sponsoring
5 | ---
6 |
7 | Using Kodiak for your commercial project?
8 |
9 | [Support Kodiak with GitHub Sponsors](https://github.com/sponsors/chdsbd) to help cover server costs and support development.
10 |
--------------------------------------------------------------------------------
/docs/docs/why-and-how.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: why-and-how
3 | title: Why and How
4 | ---
5 |
6 | ## Why?
7 |
8 | Enabling the "require branches be up to date" feature on GitHub repositories is
9 | great because, when coupled with CI, _master will always be green_.
10 |
11 | However, as the number of collaborators on a GitHub repo increases, a
12 | repetitive behavior emerges where contributors are updating their branches
13 | manually hoping to merge their branch before others.
14 |
15 | Kodiak fixes this wasteful behavior by _automatically updating
16 | and merging branches_. Contributors simply mark their
17 | PR with a (configurable) label to indicate the PR is ready to merge and Kodiak
18 | will do the rest; handling branch updates and merging using the _minimal
19 | number of branch updates_ to land the code on master.
20 |
21 | This means that contributors don't have to worry about keeping their PRs up
22 | to date with the latest on master or even pressing the merge button. Kodiak
23 | does this for them! 🎉
24 |
25 | Additionally this introduces fairness to the PR merge process as ready to
26 | merge PRs in the merge queue are merged on a first come, first served basis.
27 |
28 | ### Minimal updates
29 |
30 | Kodiak _efficiently updates pull requests_ by only updating a PR when it's ready to merge. This
31 | _prevents spurious CI jobs_ from being created as they would if all PRs were
32 | updated when their targets were updated.
33 |
34 | ## How does it work?
35 |
36 | 1. Kodiak receives a webhook event from GitHub and adds it to a per-installation queue for processing
37 | 2. Kodiak processes these webhook events and extracts the associated pull
38 | requests for further processing
39 |
40 | 3. Pull request mergeability is evaluated using PR data
41 |
42 | - kodiak configurations are checked
43 | - pull request merge states are evaluated
44 | - branch protection rules are checked
45 | - the branch is updated if necessary
46 |
47 | 4. If the PR is mergeable it's queued in a per-repo merge queue
48 |
49 | 5. A task works serially over the merge queue to update a PR and merge it
50 |
51 | 6. The pull request is merged 🎉
52 |
--------------------------------------------------------------------------------
/docs/netlify.toml:
--------------------------------------------------------------------------------
1 | # see: https://docs.netlify.com/configure-builds/file-based-configuration/
2 | [[redirects]]
3 | from = "/docs/detailed-setup"
4 | to = "/docs/config-reference"
5 | status = 302
6 |
--------------------------------------------------------------------------------
/docs/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "private": true,
3 | "volta": {
4 | "node": "12.4.0",
5 | "yarn": "1.22.17"
6 | },
7 | "devDependencies": {
8 | "@types/react": "^16.9.17",
9 | "docusaurus": "^1.14.3",
10 | "prettier": "^1.19.1",
11 | "typescript": "^3.7.4"
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/docs/pages/en/help.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | const React = require("react")
9 |
10 | // @ts-ignore
11 | const CompLibrary = require("../../core/CompLibrary.js")
12 |
13 | const Container = CompLibrary.Container
14 | const GridBlock = CompLibrary.GridBlock
15 |
16 | /** @param {{config: typeof import("../../siteConfig")}} props */
17 | function Help(props) {
18 | const supportLinks = [
19 | {
20 | content: `If you need help installing or configuring Kodiak please [open an issue on GitHub](${props.config.issuesUrl}).
21 |
22 | The team is happy to help!`,
23 | title: `[File an Issue on GitHub](${props.config.issuesUrl})`,
24 | },
25 | {
26 | content: `Take a look around Kodiak's [Troubleshooting page](/docs/troubleshooting) and [Quick Start Guide](/docs/quickstart).`,
27 | title: "Browse Docs",
28 | },
29 | {
30 | content: `Reach us privately at support@kodiakhq.com.`,
31 | title: `Send an Email`,
32 | },
33 | ]
34 |
35 | return (
36 | Logging in...
46 | ) : ( 47 |
48 |
49 | Login failure
50 |
51 | {" "}
52 | {error}
53 |
57 | {error && ( 58 | 62 | )} 63 | Return to Login 64 |
65 |38 | 41 | Install 42 | 43 | | 44 | 47 | Docs 48 | 49 | | 50 | 51 | 54 | Help 55 | 56 |
57 |