lock starters versions and create bump version script (#110)

* lock starters to specific version and cerate a bump version script * allows to bump starters by falg * fix yaml
loco-rs · Dec 10, 2023 · 8582186 · 8582186
1 parent 546ae40
commit 8582186
Show file tree

Hide file tree

Showing 24 changed files with 1,099 additions and 222 deletions.
diff --git a/.github/workflows/ci-starter-saas.yml b/.github/workflows/ci-starter-saas.yml
@@ -4,7 +4,11 @@ on:
   push:
     branches:
       - master
+    paths:
+      - starters/saas/**
   pull_request:
+    paths:
+      - starters/saas/**
 
 env:
   RUST_TOOLCHAIN: stable
@@ -101,60 +105,60 @@ jobs:
           APP_REDIS_URI: redis://localhost:${{job.services.redis.ports[6379]}}
           APP_DATABASE_URI: postgres://postgress:postgress@localhost:5432/postgress_test
 
-  generate_template:
-    name: Generate Template
-    needs: [test]
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: read
-
-    services:
-      redis:
-        image: redis
-        options: >-
-          --health-cmd "redis-cli ping"
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-        ports:
-          - "6379:6379"
-      postgres:
-        image: postgres
-        env:
-          POSTGRES_DB: postgress_test
-          POSTGRES_USER: postgress
-          POSTGRES_PASSWORD: postgress
-        ports:
-          - "5432:5432"
-        # Set health checks to wait until postgres has started
-        options: --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-
-    steps:
-      - name: Checkout the code
-        uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: ${{ env.TOOLCHAIN_PROFILE }}
-          toolchain: ${{ env.RUST_TOOLCHAIN }}
-          override: true
-      - name: Setup Rust cache
-        uses: Swatinem/rust-cache@v2
-      - name: Inject slug/short variables
-        uses: rlespinasse/github-slug-action@v3.x
-      - name: Generate template
-        run: |
-          cargo build --release --features github_ci
-          RUST_LOG=debug LOCO_CURRENT_REPOSITORY=${{ github.event.pull_request.head.repo.html_url }} LOCO_CI_MODE=true LOCO_APP_NAME=saas_starter LOCO_TEMPLATE=saas LOCO_BRANCH=${{ env.GITHUB_HEAD_REF_SLUG }} ./target/release/loco new
-          cd saas_starter
-          echo "Building generate template..."
-          cargo build --release
-          echo "Run cargo test on generated template..."
-          cargo test
-        working-directory: ./loco-cli
-        env:
-          APP_REDIS_URI: redis://localhost:${{job.services.redis.ports[6379]}}
-          APP_DATABASE_URI: postgres://postgress:postgress@localhost:5432/postgress_test
+  # generate_template:
+  #   name: Generate Template
+  #   needs: [test]
+  #   runs-on: ubuntu-latest
+
+  #   permissions:
+  #     contents: read
+
+  #   services:
+  #     redis:
+  #       image: redis
+  #       options: >-
+  #         --health-cmd "redis-cli ping"
+  #         --health-interval 10s
+  #         --health-timeout 5s
+  #         --health-retries 5
+  #       ports:
+  #         - "6379:6379"
+  #     postgres:
+  #       image: postgres
+  #       env:
+  #         POSTGRES_DB: postgress_test
+  #         POSTGRES_USER: postgress
+  #         POSTGRES_PASSWORD: postgress
+  #       ports:
+  #         - "5432:5432"
+  #       # Set health checks to wait until postgres has started
+  #       options: --health-cmd pg_isready
+  #         --health-interval 10s
+  #         --health-timeout 5s
+  #         --health-retries 5
+  #
+  # steps:
+  #   - name: Checkout the code
+  #     uses: actions/checkout@v4
+  #   - uses: actions-rs/toolchain@v1
+  #     with:
+  #       profile: ${{ env.TOOLCHAIN_PROFILE }}
+  #       toolchain: ${{ env.RUST_TOOLCHAIN }}
+  #       override: true
+  #   - name: Setup Rust cache
+  #     uses: Swatinem/rust-cache@v2
+  #   - name: Inject slug/short variables
+  #     uses: rlespinasse/github-slug-action@v3.x
+  #   - name: Generate template
+  #     run: |
+  #       cargo build --release --features github_ci
+  #       RUST_LOG=debug LOCO_CURRENT_REPOSITORY=${{ github.event.pull_request.head.repo.html_url }} LOCO_CI_MODE=true LOCO_APP_NAME=saas_starter LOCO_TEMPLATE=saas LOCO_BRANCH=${{ env.GITHUB_HEAD_REF_SLUG }} ./target/release/loco new
+  #       cd saas_starter
+  #       echo "Building generate template..."
+  #       cargo build --release
+  #       echo "Run cargo test on generated template..."
+  #       cargo test
+  #     working-directory: ./loco-cli
+  #     env:
+  #       APP_REDIS_URI: redis://localhost:${{job.services.redis.ports[6379]}}
+  #       APP_DATABASE_URI: postgres://postgress:postgress@localhost:5432/postgress_test
diff --git a/.github/workflows/ci-stateless-html.yml b/.github/workflows/ci-stateless-html.yml
@@ -4,7 +4,11 @@ on:
   push:
     branches:
       - master
+    paths:
+      - starters/stateless_html/**
   pull_request:
+    paths:
+      - starters/stateless_html/**
 
 env:
   RUST_TOOLCHAIN: stable
@@ -73,33 +77,33 @@ jobs:
         run: cargo test --all-features --all
         working-directory: ./starters/stateless_html
 
-  generate_template:
-    name: Generate Template
-    needs: [test]
-    runs-on: ubuntu-latest
+  # generate_template:
+  #   name: Generate Template
+  #   needs: [test]
+  #   runs-on: ubuntu-latest
 
-    permissions:
-      contents: read
+  #   permissions:
+  #     contents: read
 
-    steps:
-      - name: Checkout the code
-        uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: ${{ env.TOOLCHAIN_PROFILE }}
-          toolchain: ${{ env.RUST_TOOLCHAIN }}
-          override: true
-      - name: Setup Rust cache
-        uses: Swatinem/rust-cache@v2
-      - name: Inject slug/short variables
-        uses: rlespinasse/github-slug-action@v3.x
-      - name: Generate template
-        run: |
-          cargo build --release --features github_ci
-          RUST_LOG=debug  LOCO_CURRENT_REPOSITORY=${{ github.event.pull_request.head.repo.html_url }} LOCO_CI_MODE=true LOCO_APP_NAME=stateless_html_starter LOCO_TEMPLATE=stateless_html LOCO_BRANCH=${{ env.GITHUB_HEAD_REF_SLUG }} ./target/release/loco new
-          cd stateless_html_starter
-          echo "Building generate template..."
-          cargo build --release
-          echo "Run cargo test on generated template..."
-          cargo test
-        working-directory: ./loco-cli
+  #   steps:
+  #     - name: Checkout the code
+  #       uses: actions/checkout@v4
+  #     - uses: actions-rs/toolchain@v1
+  #       with:
+  #         profile: ${{ env.TOOLCHAIN_PROFILE }}
+  #         toolchain: ${{ env.RUST_TOOLCHAIN }}
+  #         override: true
+  #     - name: Setup Rust cache
+  #       uses: Swatinem/rust-cache@v2
+  #     - name: Inject slug/short variables
+  #       uses: rlespinasse/github-slug-action@v3.x
+  #     - name: Generate template
+  #       run: |
+  #         cargo build --release --features github_ci
+  #         RUST_LOG=debug  LOCO_CURRENT_REPOSITORY=${{ github.event.pull_request.head.repo.html_url }} LOCO_CI_MODE=true LOCO_APP_NAME=stateless_html_starter LOCO_TEMPLATE=stateless_html LOCO_BRANCH=${{ env.GITHUB_HEAD_REF_SLUG }} ./target/release/loco new
+  #         cd stateless_html_starter
+  #         echo "Building generate template..."
+  #         cargo build --release
+  #         echo "Run cargo test on generated template..."
+  #         cargo test
+  #       working-directory: ./loco-cli
diff --git a/.github/workflows/ci-stateless-saas.yml b/.github/workflows/ci-stateless-saas.yml
@@ -4,7 +4,11 @@ on:
   push:
     branches:
       - master
+    paths:
+      - starters/stateless/**
   pull_request:
+    paths:
+      - starters/stateless/**
 
 env:
   RUST_TOOLCHAIN: stable
@@ -73,33 +77,33 @@ jobs:
         run: cargo test --all-features --all
         working-directory: ./starters/stateless
 
-  generate_template:
-    name: Generate Template
-    needs: [test]
-    runs-on: ubuntu-latest
+  # generate_template:
+  #   name: Generate Template
+  #   needs: [test]
+  #   runs-on: ubuntu-latest
 
-    permissions:
-      contents: read
+  #   permissions:
+  #     contents: read
 
-    steps:
-      - name: Checkout the code
-        uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: ${{ env.TOOLCHAIN_PROFILE }}
-          toolchain: ${{ env.RUST_TOOLCHAIN }}
-          override: true
-      - name: Setup Rust cache
-        uses: Swatinem/rust-cache@v2
-      - name: Inject slug/short variables
-        uses: rlespinasse/github-slug-action@v3.x
-      - name: Generate template
-        run: |
-          cargo build --release --features github_ci
-          RUST_LOG=debug  LOCO_CURRENT_REPOSITORY=${{ github.event.pull_request.head.repo.html_url }} LOCO_CI_MODE=true LOCO_APP_NAME=stateless_starter LOCO_TEMPLATE=stateless LOCO_BRANCH=${{ env.GITHUB_HEAD_REF_SLUG }} ./target/release/loco new
-          cd stateless_starter
-          echo "Building generate template..."
-          cargo build --release
-          echo "Run cargo test on generated template..."
-          cargo test
-        working-directory: ./loco-cli
+  #   steps:
+  #     - name: Checkout the code
+  #       uses: actions/checkout@v4
+  #     - uses: actions-rs/toolchain@v1
+  #       with:
+  #         profile: ${{ env.TOOLCHAIN_PROFILE }}
+  #         toolchain: ${{ env.RUST_TOOLCHAIN }}
+  #         override: true
+  #     - name: Setup Rust cache
+  #       uses: Swatinem/rust-cache@v2
+  #     - name: Inject slug/short variables
+  #       uses: rlespinasse/github-slug-action@v3.x
+  #     - name: Generate template
+  #       run: |
+  #         cargo build --release --features github_ci
+  #         RUST_LOG=debug  LOCO_CURRENT_REPOSITORY=${{ github.event.pull_request.head.repo.html_url }} LOCO_CI_MODE=true LOCO_APP_NAME=stateless_starter LOCO_TEMPLATE=stateless LOCO_BRANCH=${{ env.GITHUB_HEAD_REF_SLUG }} ./target/release/loco new
+  #         cd stateless_starter
+  #         echo "Building generate template..."
+  #         cargo build --release
+  #         echo "Run cargo test on generated template..."
+  #         cargo test
+  #       working-directory: ./loco-cli
diff --git a/starters/README.md b/starters/README.md
@@ -0,0 +1,23 @@
+# Starters Overview
+
+Loco starters provide a straightforward way to initiate a Loco project, minimizing user effort and facilitating the seamless adoption of Loco.
+
+## How It Works
+
+The [loco-cli](../loco-cli/README.md) dynamically searches for all available starter projects in the starters root path during runtime. It then prompts the user to choose from the available starters.
+
+Starters **must be work**, as users often start with these projects, and it's crucial to provide a positive first impression :).
+
+When releasing a new version of the Loco library, we utilize xtask utilities, which automatically update the Loco version and the starters, locking them to the updated version.
+
+## When to Update a Starter
+
+Ideally, **avoid** making changes to the starters. Starters should have minimal implementations.
+
+## When to Add a New Starter
+
+We recommend not submitting a pull request (PR) with a new starter right away. Instead, feel free to open a [PR](https://github.com/loco-rs/loco/issues/new/choose) and as and consult with us before investing your time.
+
+## Handling Breaking Changes
+
+When making breaking changes, there is generally no need to update the starters. During version bumps, we thoroughly test the starter projects and make any necessary adjustments if needed.
diff --git a/starters/saas/Cargo.toml b/starters/saas/Cargo.toml
@@ -9,7 +9,7 @@ edition = "2021"
 
 [dependencies]
 
-loco-rs = { path = "../../" }
+loco-rs = { version = "0.1.5" }
 migration = { path = "migration" }
 
 serde = { version = "1", features = ["derive"] }
@@ -40,6 +40,6 @@ required-features = []
 [dev-dependencies]
 serial_test = "2.0.0"
 rstest = "0.18.2"
-loco-rs = { path = "../../", features = ["testing"] }
+loco-rs = { version = "0.1.5", features = ["testing"] }
 trycmd = "0.14.19"
 insta = { version = "1.34.0", features = ["redactions", "yaml", "filters"] }
diff --git a/starters/saas/generator.yaml b/starters/saas/generator.yaml
@@ -1,11 +1,6 @@
 ---
 description: Saas app (with DB and user auth)
 rules:
-  - pattern: loco-rs = \{ path = +.(.*/)+.
-    skip_in_ci: true
-    kind: loco-rs = { version = "*"
-    file_patterns:
-      - toml
   - pattern: loco_starter_template
     kind: LibName
     file_patterns:

diff --git a/starters/saas/migration/Cargo.toml b/starters/saas/migration/Cargo.toml
@@ -10,7 +10,7 @@ path = "src/lib.rs"
 
 [dependencies]
 async-std = { version = "1", features = ["attributes", "tokio1"] }
-loco-rs = { path = "../../../" }
+loco-rs = { version = "0.1.5" }
 
 [dependencies.sea-orm-migration]
 version = "0.12.4"

diff --git a/starters/stateless/Cargo.toml b/starters/stateless/Cargo.toml
@@ -9,7 +9,7 @@ edition = "2021"
 
 [dependencies]
 
-loco-rs = { path = "../../", default-features = false, features = ["cli"] }
+loco-rs = { version = "0.1.5", default-features = false, features = ["cli"] }
 serde = "*"
 serde_json = "*"
 eyre = "*"
@@ -31,7 +31,7 @@ required-features = []
 [dev-dependencies]
 serial_test = "*"
 rstest = "*"
-loco-rs = { path = "../../", default-features = false, features = [
+loco-rs = { version = "0.1.5", default-features = false, features = [
     "testing",
     "cli",
 ] }

diff --git a/starters/stateless/generator.yaml b/starters/stateless/generator.yaml
@@ -1,11 +1,6 @@
 ---
 description: Stateless service (minimal, no db)
 rules:
-  - pattern: loco-rs = \{ path = +.(../../)+.
-    skip_in_ci: true
-    kind: loco-rs = { version = "*"
-    file_patterns:
-      - Cargo.toml
   - pattern: loco_starter_template
     kind: LibName
     file_patterns:

diff --git a/starters/stateless_html/Cargo.toml b/starters/stateless_html/Cargo.toml
@@ -9,7 +9,7 @@ edition = "2021"
 
 [dependencies]
 
-loco-rs = { path = "../../", default-features = false, features = ["cli"] }
+loco-rs = { version = "0.1.5", default-features = false, features = ["cli"] }
 serde = "*"
 serde_json = "*"
 eyre = "*"
@@ -32,7 +32,7 @@ required-features = []
 [dev-dependencies]
 serial_test = "*"
 rstest = "*"
-loco-rs = { path = "../../", default-features = false, features = [
+loco-rs = { version = "0.1.5", default-features = false, features = [
     "testing",
     "cli",
 ] }

diff --git a/starters/stateless_html/generator.yaml b/starters/stateless_html/generator.yaml
@@ -1,11 +1,6 @@
 ---
 description: Stateless HTML (minimal, no db)
 rules:
-  - pattern: loco-rs = \{ path = +.(../../)+.
-    skip_in_ci: true
-    kind: loco-rs = { version = "*"
-    file_patterns:
-      - Cargo.toml
   - pattern: loco_starter_template
     kind: LibName
     file_patterns: