ci: rework for simplicity (#80)

Signed-off-by: tison <[email protected]>

.github/workflows/ci.yml

@@ -1,3 +1,17 @@
+# Copyright 2023 Greptime Team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 name: CI
 
 on:
@@ -25,55 +39,45 @@ on:
 env:
   CARGO_TERM_COLOR: always
 
-jobs:
-  typos:
-    name: Spell Check with Typos
-    if: github.event.pull_request.draft == false
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: crate-ci/[email protected]
+# Concurrency strategy:
+#   github.workflow: distinguish this workflow from others
+#   github.event_name: distinguish `push` event from `pull_request` event
+#   github.event.number: set to the number of the pull request if `pull_request` event
+#   github.run_id: otherwise, it's a `push` event, only cancel if we rerun the workflow
+#
+# Reference:
+#   https://docs.github.com/en/actions/using-jobs/using-concurrency
+#   https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.number || github.run_id }}
+  cancel-in-progress: true
 
+jobs:
   check:
     name: Check
-    if: github.event.pull_request.draft == false
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
+      - uses: actions/checkout@v4
+      - uses: korandoru/hawkeye@v4
       - uses: Swatinem/rust-cache@v2
+      - uses: crate-ci/[email protected]
+      - run: cargo fmt --all -- --check
+      - run: cargo clippy --all-targets -- -D warnings
       - run: cargo check
 
-  fmt:
-    name: Rustfmt
-    if: github.event.pull_request.draft == false
+  coverage:
+    name: Coverage
     runs-on: ubuntu-latest
+    env:
+      CARGO_TERM_COLOR: always
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
+      - uses: actions/checkout@v4
       - uses: Swatinem/rust-cache@v2
-      - run: rustup component add rustfmt
-      - run: cargo fmt --all -- --check
-
-  clippy:
-    name: Clippy
-    if: github.event.pull_request.draft == false
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: taiki-e/install-action@cargo-llvm-cov
+      - name: Generate code coverage
+        run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
         with:
-          profile: minimal
-          toolchain: stable
-          override: true
-      - uses: Swatinem/rust-cache@v2
-      - run: rustup component add clippy
-      - run: cargo clippy --all-targets -- -D warnings
+          files: lcov.info
+          fail_ci_if_error: true

.github/workflows/release.yml

@@ -1,3 +1,17 @@
+# Copyright 2023 Greptime Team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 name: Release
 run-name: publish packages by @${{ github.actor }}
 
@@ -10,10 +24,5 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - name: Set up Rust
-        uses: hecrj/setup-rust-action@v1
-      - uses: actions/checkout@v2
-      - name: Publish
-        shell: bash
-        run: |
-          cargo publish --token ${{ secrets.CRATES_TOKEN }}
+      - uses: actions/checkout@v4
+      - run: cargo publish --token ${{ secrets.CRATES_TOKEN }}

.github/workflows/semantic-pull-request.yml

@@ -0,0 +1,34 @@
+# Copyright 2023 Greptime Team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Semantic Pull Request
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - labeled
+      - unlabeled
+
+jobs:
+  check:
+    name: Check pull request title
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Cargo.toml

@@ -1,3 +1,17 @@
+# Copyright 2023 Greptime Team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 [package]
 name = "promql-parser"
 readme = "README.md"

README.md

@@ -16,7 +16,12 @@ To parse a simple instant vector selector expression:
 ``` rust
 use promql_parser::parser;
 
-let promql = r#"http_requests_total{environment=~"staging|testing|development",method!="GET"} offset 5m"#;
+let promql = r#"
+    http_requests_total{
+        environment=~"staging|testing|development",
+        method!="GET"
+    } offset 5m
+"#;
 
 match parser::parse(promql) {
     Ok(expr) => {
@@ -80,5 +85,5 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
 licensed as above, without any additional terms or conditions.
 
-[prom-v2.45.0]: https://github.com/prometheus/prometheus/tree/v2.45.0
+[prom-v2.45.0]: https://github.com/prometheus/prometheus/blob/v2.45.0/promql/
 [querying-prometheus]: https://prometheus.io/docs/prometheus/latest/querying/basics/

codecov.yml

@@ -1,3 +1,17 @@
+# Copyright 2023 Greptime Team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 coverage:
   status:
     project:

examples/parser.rs

@@ -15,7 +15,12 @@
 use promql_parser::parser;
 
 fn main() {
-    let promql = r#"http_requests_total{environment=~"staging|testing|development",method!="GET"} offset 5m"#;
+    let promql = r#"
+        http_requests_total{
+            environment=~"staging|testing|development",
+            method!="GET"
+        } offset 5m
+    "#;
 
     match parser::parse(promql) {
         Ok(expr) => {

licenserc.toml

@@ -0,0 +1,26 @@
+# Copyright 2023 Greptime Team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+headerPath = "Apache-2.0.txt"
+
+includes = [
+    "*.rs",
+    "*.toml",
+    "*.yaml",
+    "*.yml",
+]
+
+[properties]
+inceptionYear = 2023
+copyrightOwner = "Greptime Team"