ci: added knope for managing releases (#547)

Author: dotansimha

.gemini/styleguide.md

@@ -80,3 +80,11 @@ async fn handle(user: &User, req: &Request) -> Result<Response> {
     tracing::trace!(%user.id, %req.id, "entered handler");
     Ok(...)
 }
+
+## Releasing
+
+We are using `knope` with changesets for declaring changes. If you detect a new file in a PR under `.changeset/` directory, please confirm the following rules:
+
+- Every new `changesets` file that touches `query-planner` must have a `router` changeset - either in the same changeset or a separate changeset.
+- Every new `changesets` file that touches `executor` must have a `query-planner` changeset - either in the same changeset or a separate changeset.
+- If a PR touches `config` crate and adds/changes to the `HiveRouterConfig` struct, it must have a `router` changeset that contains a YAML example on how the configuration needs to be used.

.github/workflows/release.yaml

@@ -20,38 +20,38 @@ jobs:
       - uses: actions-rust-lang/setup-rust-toolchain@1780873c7b576612439a134613cc4cc74ce5538c # v1
         with:
           cache: false
-      - name: Authenticate with crates.io
+      - name: authenticate with crates.io
         uses: rust-lang/crates-io-auth-action@v1
         id: auth
-      - name: release-plz release
-        uses: release-plz/action@d529f731ae3e89610ada96eda34e5c6ba3b12214 # v0.5.118
-        with:
-          command: release
-        env:
-          GITHUB_TOKEN: ${{ secrets.RELEASE_PLZ_TOKEN }}
-          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
+      # - name: release-plz release
+      #   uses: release-plz/action@d529f731ae3e89610ada96eda34e5c6ba3b12214 # v0.5.118
+      #   with:
+      #     command: release
+      #   env:
+      #     GITHUB_TOKEN: ${{ secrets.RELEASE_PLZ_TOKEN }}
+      #     CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
 
-  release-pr:
-    name: pr
-    runs-on: ubuntu-latest
-    if: ${{ github.repository_owner == 'graphql-hive' }}
-    concurrency:
-      group: create-release-pr-${{ github.ref }}
-      cancel-in-progress: false
-    steps:
-      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
-        with:
-          fetch-depth: 0
-      - uses: actions-rust-lang/setup-rust-toolchain@1780873c7b576612439a134613cc4cc74ce5538c # v1
-        with:
-          cache: false
-      - name: Authenticate with crates.io
-        uses: rust-lang/crates-io-auth-action@v1
-        id: auth
-      - name: release-plz release-pr
-        uses: release-plz/action@d529f731ae3e89610ada96eda34e5c6ba3b12214 # v0.5.118
-        with:
-          command: release-pr
-        env:
-          GITHUB_TOKEN: ${{ secrets.RELEASE_PLZ_TOKEN }}
-          CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
+  # release-pr:
+  #   name: pr
+  #   runs-on: ubuntu-latest
+  #   if: ${{ github.repository_owner == 'graphql-hive' }}
+  #   concurrency:
+  #     group: create-release-pr-${{ github.ref }}
+  #     cancel-in-progress: false
+  #   steps:
+  #     - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+  #       with:
+  #         fetch-depth: 0
+  #     - uses: actions-rust-lang/setup-rust-toolchain@1780873c7b576612439a134613cc4cc74ce5538c # v1
+  #       with:
+  #         cache: false
+  #     - name: Authenticate with crates.io
+  #       uses: rust-lang/crates-io-auth-action@v1
+  #       id: auth
+  # - name: release-plz release-pr
+  #   uses: release-plz/action@d529f731ae3e89610ada96eda34e5c6ba3b12214 # v0.5.118
+  #   with:
+  #     command: release-pr
+  #   env:
+  #     GITHUB_TOKEN: ${{ secrets.RELEASE_PLZ_TOKEN }}
+  #     CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}

README.md

@@ -52,7 +52,7 @@ See [GitHub Releases](https://github.com/graphql-hive/router/releases) to the fu
 
 ### Docker
 
-The router image is being published to [Docker to GitHub Container Registry](). You may use it directly using the following command:
+The router image is being published to [Docker to GitHub Container Registry](https://github.com/graphql-hive/router/pkgs/container/router). You may use it directly using the following command:
 
 ```bash
 docker run \

knope.toml

@@ -0,0 +1,46 @@
+[bot.releases]
+enabled = true
+
+[github]
+owner = "graphql-hive"
+repo = "router"
+
+[packages.query-planner]
+versioned_files = ["lib/query-planner/Cargo.toml", { path = "lib/executor/Cargo.toml", dependency = "hive-router-query-planner" }, { path = "bin/router/Cargo.toml", dependency = "hive-router-query-planner" }, "Cargo.lock"]
+scopes = ["hive-router-query-planner", "qp", "query-planner"]
+changelog = "lib/query-planner/CHANGELOG.md"
+
+[packages.executor]
+versioned_files = ["lib/executor/Cargo.toml", { path = "bin/router/Cargo.toml", dependency = "hive-router-plan-executor" }, "Cargo.lock"]
+scopes = ["hive-router-plan-executor", "executor"]
+changelog = "lib/executor/CHANGELOG.md"
+
+[packages.router]
+versioned_files = ["bin/router/Cargo.toml", "Cargo.lock"]
+scopes = ["hive-router", "router", "config", "qp", "executor"]
+changelog = "bin/router/CHANGELOG.md"
+
+# "release" pipeline that prepares the release and pushes a release PR
+[[workflows]]
+name = "release"
+  [[workflows.steps]]
+  type = "PrepareRelease"
+  ignore_conventional_commits = true
+  [[workflows.steps]]
+  type = "Command"
+  command = 'git commit -m "chore: prepare releases"'
+  [[workflows.steps]]
+  type = "Command"
+  command = "git push"
+  [[workflows.steps]]
+  type = "Release"
+
+# "document-change" pipeline that prepares the release and pushes a release PR
+[[workflows]]
+name = "document-change"
+  [[workflows.steps]]
+  type = "CreateChangeFile"
+[[workflows]]
+name = "changeset"
+  [[workflows.steps]]
+  type = "CreateChangeFile"