pipecraft 0.0.0-releaseit

package/.github/workflows/pipeline.yml

@@ -0,0 +1,220 @@
+name: "Pipeline"
+run-name: "${{ github.ref_name }} #${{ inputs.run_number || github.run_number }}${{ inputs.version && format(' - {0}', inputs.version) || '' }}"
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: The version to deploy
+        required: false
+        type: string
+      baseRef:
+        description: The base reference for comparison
+        required: false
+        type: string
+      run_number:
+        description: The original run number from develop branch
+        required: false
+        type: string
+  push:
+    branches:
+      - develop
+      - staging
+      - main
+jobs:
+
+  #=============================================================================
+  # CHANGES DETECTION
+  #=============================================================================
+  changes:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/detect-changes
+        id: detect
+        with:
+          baseRef: ${{ inputs.baseRef || 'main' }}
+    outputs:
+      cicd: ${{ steps.detect.outputs.cicd }}
+      core: ${{ steps.detect.outputs.core }}
+      test: ${{ steps.detect.outputs.test }}
+
+  #=============================================================================
+  # TESTING JOBS
+  #=============================================================================
+  test-cicd:
+    needs: changes
+    if: ${{ needs.changes.outputs.cicd == 'true' }}
+    runs-on: ubuntu-latest
+    steps:
+      # TODO: Replace with your cicd test logic
+      - name: Run cicd tests
+        run: |
+          echo "Running tests for cicd domain"
+          echo "Replace this with your actual test commands"
+          # Example: npm test -- --testPathPattern=cicd
+
+  test-core:
+    needs: changes
+    if: ${{ needs.changes.outputs.core == 'true' }}
+    runs-on: ubuntu-latest
+    steps:
+      # TODO: Replace with your core test logic
+      - name: Run core tests
+        run: |
+          echo "Running tests for core domain"
+          echo "Replace this with your actual test commands"
+          # Example: npm test -- --testPathPattern=core
+
+  test-test:
+    needs: changes
+    if: ${{ needs.changes.outputs.test == 'true' }}
+    runs-on: ubuntu-latest
+    steps:
+      # TODO: Replace with your test test logic
+      - name: Run test tests
+        run: |
+          echo "Running tests for test domain"
+          echo "Replace this with your actual test commands"
+          # Example: npm test -- --testPathPattern=test
+
+  version:
+    if: ${{
+        always() && (
+          needs.test-cicd.result == 'success' ||
+          needs.test-core.result == 'success' ||
+          needs.test-test.result == 'success'
+        ) &&
+        (
+          needs.test-cicd.result != 'failure' &&
+          needs.test-core.result != 'failure' &&
+          needs.test-test.result != 'failure'
+        )
+      }}
+    needs: [ changes, test-cicd, test-core, test-test ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/calculate-version
+        id: version
+        with:
+          baseRef: ${{ inputs.baseRef || 'main' }}
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+
+  #=============================================================================
+  # DEPLOYMENT JOBS
+  #=============================================================================
+  deploy-core:
+    needs: [ changes, version ]
+    if: ${{ always() && needs.changes.outputs.core == 'true'  && needs.version.result == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy core
+        run: |
+          echo "Deploying core"
+          echo "Replace this with your actual deploy commands"
+          # Example: npm deploy -- --testPathPattern=core
+
+  #=============================================================================
+  # REMOTE TESTING JOBS
+  #=============================================================================
+  remote-test-core:
+    needs: [ deploy-core, changes ]
+    if: ${{ always() && needs.deploy-core.result == 'success' && needs.changes.outputs.core == 'true' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Test core
+        run: |
+          echo "Testing core remotely"
+          echo "Replace this with your actual test commands"
+          # Example: npm test -- --testPathPattern=core
+
+  #=============================================================================
+  # TAG & PROMOTE
+  #=============================================================================
+  tag:
+    # Needs all deploy and/or remote test jobs to succeed or be skipped
+    # Needs at least one domain to succeed
+    needs: [ version, deploy-core, remote-test-core ]
+    if: ${{
+        always() &&
+        github.ref_name == 'develop' &&
+        needs.version.result == 'success' &&
+        (
+        needs.deploy-core.result != 'failure' &&
+        needs.remote-test-core.result != 'failure'
+      ) &&
+        (
+        needs.deploy-core.result == 'success' ||
+        needs.remote-test-core.result == 'success'
+      )
+      }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/create-tag
+        with:
+          version: ${{ needs.version.outputs.version }}
+  #=============================================================================
+  # PROMOTION JOB
+  #=============================================================================
+  promote:
+    # Only runs on push or manual workflow_dispatch events to branches that can promote
+    # Waits for version/tag if they run, but doesn't fail if they're skipped
+    # Needs all deploy and/or remote test jobs to succeed
+    if: ${{
+        always() &&
+        (
+        github.event_name == 'push' ||
+        github.event_name == 'workflow_dispatch'
+      ) &&
+        (
+        needs.version.result == 'success' ||
+        needs.version.result == 'skipped'
+      ) &&
+        (
+        needs.tag.result == 'success' ||
+        needs.tag.result == 'skipped'
+      ) &&
+        (
+        github.ref_name == 'develop' ||
+        github.ref_name == 'staging'
+      )
+      }}
+    needs: [ version, tag ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/promote-branch
+        with:
+          sourceBranch: ${{ github.ref_name }}
+          version: ${{ needs.version.outputs.version }}
+          run_number: ${{ inputs.run_number || github.run_number }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  #=============================================================================
+  # RELEASE JOB (Main Branch Only)
+  #=============================================================================
+  release:
+    # Create GitHub release on main branch after successful tests and versioning
+    if: ${{
+        always() &&
+        github.ref_name == 'main' &&
+        (
+        github.event_name == 'push' ||
+        github.event_name == 'workflow_dispatch'
+      ) &&
+        needs.version.result == 'success' &&
+        (
+        needs.tag.result == 'success' ||
+        needs.tag.result == 'skipped'
+      )
+      }}
+    needs: [ version, tag ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/create-release
+        with:
+          version: ${{ needs.version.outputs.version }}
+          token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/pr-title-check.yml

@@ -0,0 +1,70 @@
+name: "PR Title Format Check"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - reopened
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - reopened
+
+permissions:
+  pull-requests: read
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        id: lint_pr_title
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # Configure which types are allowed (newline-delimited).
+          # Default: https://github.com/commitizen/conventional-commit-types
+          types: |
+            fix
+            feat
+            docs
+            style
+            chore
+            refactor
+            perf
+            test
+            ci
+            build
+            revert
+            major
+          requireScope: false
+
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        # When the previous steps fails, the workflow would stop. By adding this
+        # condition you can continue the execution with the populated error message.
+        if: always() && (steps.lint_pr_title.outputs.error_message != null)
+        with:
+          header: pr-title-lint-error
+          message: |
+            Hey there and thank you for opening this pull request! 👋🏼
+            
+            We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
+
+            Details:
+            
+            ```
+            ${{ steps.lint_pr_title.outputs.error_message }}
+            ```
+
+      # Delete a previous comment when the issue has been resolved
+      - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:   
+          header: pr-title-lint-error
+          delete: true

package/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Publish to npm
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Release tag to publish (e.g., v1.2.3)'
+        required: true
+        type: string
+
+permissions:
+  contents: read
+  id-token: write  # Required for OIDC
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name || inputs.tag }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build package
+        run: npm run build
+
+      - name: Publish to npm
+        run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.pipecraftrc.json

@@ -0,0 +1,78 @@
+{
+  "ciProvider": "github",
+  "mergeStrategy": "fast-forward",
+  "requireConventionalCommits": true,
+  "initialBranch": "develop",
+  "finalBranch": "main",
+  "branchFlow": [
+    "develop",
+    "staging",
+    "main"
+  ],
+  "autoMerge": {
+    "staging": true,
+    "main": true
+  },
+  "semver": {
+    "bumpRules": {
+      "feat": "minor",
+      "fix": "patch",
+      "breaking": "major"
+    }
+  },
+  "actions": {
+    "onDevelopMerge": [
+      "runTests",
+      "fastForwardToStaging"
+    ],
+    "onStagingMerge": [
+      "runTests",
+      "calculateVersion",
+      "createOrFastForwardToMain"
+    ]
+  },
+  "domains": {
+    "core": {
+      "paths": [
+        "src/**"
+      ],
+      "test": true,
+      "deploy": true,
+      "remoteTest": true,
+      "description": "PipeCraft core changes"
+    },
+    "test": {
+      "paths": [
+        "tests/**"
+      ],
+      "test": true,
+      "description": "PipeCraft test changes"
+    },
+    "cicd": {
+      "paths": [
+        ".github/**"
+      ],
+      "test": true,
+      "description": "PipeCraft CI/CD changes"
+    }
+  },
+  "versioning": {
+    "enabled": true,
+    "releaseItConfig": ".release-it.cjs",
+    "conventionalCommits": true,
+    "autoTag": true,
+    "autoPush": false,
+    "changelog": true,
+    "bumpRules": {
+      "feat": "minor",
+      "fix": "patch",
+      "breaking": "major"
+    }
+  },
+  "rebuild": {
+    "enabled": true,
+    "skipIfUnchanged": true,
+    "forceRegenerate": false,
+    "cacheFile": ".pipecraft-cache.json"
+  }
+}

package/.release-it.cjs

@@ -0,0 +1,71 @@
+module.exports = {
+    "git": {
+      "requireCleanWorkingDir": false,
+      "commit": false,
+      "pushArgs": ["--tags"],
+      "tagMatch": "v[0-9]*.[0-9]*.[0-9]*" // Required to exclude non-versioning tags
+    },
+    "github": {
+      "release": true,
+      "releaseName": "Release ${version}"
+    },
+    "npm": {
+      "ignoreVersion": true,
+      "publish": false,
+      "skipChecks": true
+    },
+    "hooks": {
+      "after:release": "echo ${version} > .release-version"
+    },
+
+    
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "whatBump": (commits,options)=>{
+            let defaults = {
+              test: 'ignore',
+              build: 'ignore',
+
+              ci: 'patch',
+              docs: 'patch',
+              chore: 'minor',
+              style: 'patch',
+              fix: 'patch',
+              perf: 'patch',
+              refactor: 'patch',
+
+              feat: 'minor',
+              major: 'major',
+            }
+   
+            let types = (options?.preset?.types || [])
+            .reduce((a, v) => {
+              return { ...a, [v.type]: v.release}
+            }, {}) 
+  
+            types = Object.assign({},defaults,types)
+            let breakings = 0
+            let features = 0
+            let levelSet = ['major','minor','patch','ignore']
+            let level = Math.min.apply(Math, commits.map(commit => {
+              let level = levelSet.indexOf(types[commit.type])
+              level = level<0?3:level
+              if (commit.notes.length > 0) {
+                breakings += commit.notes.length
+              }
+              if(commit.type === 'feat'){
+                features += 1;
+              }
+              return level
+            }))
+            return {
+              level: level,
+              reason: breakings === 1
+                ? `There is ${breakings} BREAKING CHANGE and ${features} features`
+                : `There are ${breakings} BREAKING CHANGES and ${features} features`
+            }
+        },
+      }
+    }
+  }
+