Merge branch 'main' of https://github.com/Sideko-Inc/sideko

Author: pk8189

Cargo.lock

@@ -1,5 +1,5 @@
 [workspace]
-members = ["sideko", "docs"]
+members = ["sideko", "docs", "sideko-py"]
 resolver = "2"
 
 # The profile that 'dist' will build with

Cargo.toml

@@ -39,7 +39,7 @@ curl -fsSL https://raw.githubusercontent.com/Sideko-Inc/sideko/main/install.sh |
 
 ## Quickstart - Premium SDKs in Seconds
 ```bash
-# authenticate
+# authenticate (uses native keychain to store credentials on host)
 sideko login
 
 # interactively create sdks

README.md

@@ -120,6 +120,9 @@ create a new version of an api with an openapi spec
 * `--name <NAME>` — api name or id e.g. my-api
 * `--version <VERSION>` — semantic version (e.g. `2.1.5`) or version bump (`patch`, `minor`, `major`, `rc`)
 * `--spec <SPEC>` — path to openapi specification (YAML or JSON format)
+* `--allow-lint-errors` — Allow linting errors to be present in the provided spec [default: false]
+
+   By default creating a new version with an OpenAPI that contains linting errors is disallowed. If you wish to allow linting errors you may experience issues later with SDK generation or mock servers.
 * `--disable-mock` — disable mock server for new version [default: enabled]
 * `--display <DISPLAY>` — display result as a raw json or prettified
 
@@ -161,6 +164,9 @@ updates an existing api version
 * `--version <VERSION>` — version to update (e.g. `2.1.5` or `latest`)
 * `--new-version <NEW_VERSION>` — version to update with (e.g. `2.1.5`)
 * `--spec <SPEC>` — path to openapi spec (yaml or json format) to update with
+* `--allow-lint-errors` — Allow linting errors to be present in the provided spec [default: false]
+
+   By default using an OpenAPI that contains linting errors is disallowed. If you wish to allow linting errors you may experience issues later with SDK generation or mock servers.
 * `--mock <MOCK>` — enable or disable the mock server
 
   Possible values: `true`, `false`
@@ -199,6 +205,9 @@ create a new api
 * `--name <NAME>` — name of api (only alphanumeric characters and dashes, e.g. `my-api`)
 * `--version <VERSION>` — semantic version of initial version (e.g. `0.1.0`)
 * `--spec <SPEC>` — path to openapi spec of initial version (yaml or json format)
+* `--allow-lint-errors` — Allow linting errors to be present in the provided spec [default: false]
+
+   By default using an OpenAPI that contains linting errors is disallowed. If you wish to allow linting errors you may experience issues later with SDK generation or mock servers.
 * `--disable-mock` — disable mock server for initial version [default: enabled]
 * `--display <DISPLAY>` — display result as a raw json or prettified
 
@@ -260,6 +269,7 @@ linting errors gathered from the specification
 * `--version <VERSION>` — API version e.g. v1, latest
 
   Default value: `latest`
+* `--errors` — Show errors only
 * `--display <DISPLAY>` — display result as a raw json or prettified
 
   Default value: `pretty`

docs/CLI.md

@@ -192,14 +192,18 @@ def main():
     )
     parser.add_argument(
         "--version",
+        required=True,
         help="Version to release (if not provided, will use current version)",
     )
     args = parser.parse_args()
 
-    current_version = get_current_version()
-    if not args.version:
-        raise Exception(f"Must specify version. Current is: {current_version}")
+    # Confirm there are no rust compile-time issues
+    run_command("cargo check", check=True)
+
+    # Confirm `gh` CLI is installed & authenticated
+    run_command("gh auth status", check=True)
 
+    current_version = get_current_version()
     version = args.version
     print(f"\nBumping version from {current_version} to {version}")
 
@@ -245,10 +249,11 @@ def main():
     # 3. Restore sideko-py
     print("\nStep 3: Restoring sideko-py to workspace...")
     update_workspace_toml(delete=False)
-    show_git_diff([Path("Cargo.toml")])
+    run_command("cargo check", check=True)  # run cargo check to update lockfile
+    show_git_diff([Path("Cargo.toml"), Path("Cargo.lock")])
     if not confirm_action("Does this look correct?"):
         print("Aborting on user request")
-        run_command("git restore Cargo.toml")
+        run_command("git restore Cargo.toml Cargo.lock")
         sys.exit(1)
 
     # 4. Push changes
@@ -265,10 +270,11 @@ def main():
     # 6. Remove sideko-py again
     print("\nStep 6: Removing sideko-py from workspace...")
     update_workspace_toml(delete=True)
-    show_git_diff([Path("Cargo.toml")])
+    run_command("cargo check", check=True)  # run cargo check to update lockfile
+    show_git_diff([Path("Cargo.toml"), Path("Cargo.lock")])
     if not confirm_action("Does this look correct?"):
         print("Aborting on user request")
-        run_command("git restore Cargo.toml")
+        run_command("git restore Cargo.toml Cargo.lock")
         sys.exit(1)
 
     # 7. Final push

release.py

@@ -1,7 +1,7 @@
 [package]
 name = "sideko-py"
 description = "Generate & manage SDKs with the Sideko CLI"
-version = "1.1.0"
+version = "1.1.1"
 edition = "2021"
 authors = [
     "Elias Posen <elias@sideko.dev>",

sideko-py/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "sideko"
-version = "1.1.0"
+version = "1.1.1"
 edition = "2021"
 authors = [
     "Elias Posen <elias@sideko.dev>",
@@ -32,7 +32,7 @@ tar = "0.4.40"
 tokio = { version = "1.35.1", features = ["time"] }
 url = "2.4.1"
 semver = "1.0.23"
-sideko_rest_api = "0.5.1"
+sideko_rest_api = "0.5.2"
 tempfile = "3.12.0"
 dotenvy = "0.15.7"
 tabled = "0.18.0"

sideko/Cargo.toml

@@ -27,6 +27,13 @@ pub struct ApiCreateCommand {
     )]
     pub spec: Utf8PathBuf,
 
+    /// Allow linting errors to be present in the provided spec [default: false]
+    ///
+    /// By default using an OpenAPI that contains linting errors is disallowed.
+    /// If you wish to allow linting errors you may experience issues later with SDK generation or mock servers.
+    #[arg(long)]
+    pub allow_lint_errors: bool,
+
     /// disable mock server for initial version [default: enabled]
     #[arg(long)]
     pub disable_mock: bool,
@@ -50,6 +57,7 @@ impl ApiCreateCommand {
                     )
                 })?,
                 version: VersionOrBump::Str(self.version.clone()),
+                allow_lint_errors: Some(self.allow_lint_errors),
                 ..Default::default()
             })
             .await?;

sideko/src/cmds/api/create.rs

@@ -30,6 +30,10 @@ pub struct LintCommand {
     #[arg(long, default_value = "latest")]
     pub version: Option<String>,
 
+    /// Show errors only
+    #[arg(long)]
+    pub errors: bool,
+
     /// display result as a raw json or prettified
     #[arg(long, default_value = "pretty")]
     pub display: DisplayOutput,
@@ -75,9 +79,13 @@ impl LintCommand {
             DisplayOutput::Pretty => {
                 let filename =
                     if let Some(Some(filename)) = self.spec.as_ref().map(|p| p.file_name()) {
-                        filename
+                        filename.to_string()
                     } else {
-                        "openapi"
+                        format!(
+                            "{name}-{version}-openapi",
+                            name = self.name.clone().unwrap_or_default(),
+                            version = self.version.clone().unwrap_or_default()
+                        )
                     };
 
                 // build summary table
@@ -136,10 +144,14 @@ impl LintCommand {
                 // display full results table
                 if !report.results.is_empty() {
                     let mut report_table =
-                        tabled::Table::new(report.results.into_iter().map(|result| {
-                            TabledLintResult {
-                                filename: filename.to_string(),
-                                result,
+                        tabled::Table::new(report.results.into_iter().filter_map(|result| {
+                            if !self.errors || matches!(&result.severity, LintSeverityEnum::Error) {
+                                Some(TabledLintResult {
+                                    filename: filename.to_string(),
+                                    result,
+                                })
+                            } else {
+                                None
                             }
                         }));
                     utils::tabled::header_panel(