turbot · kaidaguerre · Jan 30, 2025 · Jun 20, 2024 · Jun 21, 2024 · Jun 24, 2024
diff --git a/.acceptance.goreleaser.yml b/.acceptance.goreleaser.yml
@@ -0,0 +1,24 @@
+before:
+  hooks:
+    - go mod tidy
+builds:
+  - id: tailpipe-linux-amd64
+    binary: tailpipe
+    goos:
+      - linux
+    goarch:
+      - amd64
+
+    env:
+      - CC=x86_64-linux-gnu-gcc
+      - CXX=x86_64-linux-gnu-g++
+
+    ldflags:
+      - -s -w -X main.version={{.Version}} -X main.date={{.Date}} -X main.commit={{.Commit}} -X main.builtBy=goreleaser
+
+archives:
+  - id: homebrew
+    format: tar.gz
+    name_template: "{{ .ProjectName }}.{{ .Os }}.{{ .Arch }}"
+    files:
+      - none*
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Tailpipe version (`tailpipe -v`)**
+Example: v0.1.0
+
+**To reproduce**
+Steps to reproduce the behavior (please include relevant code and/or commands).
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/release_issue.md b/.github/ISSUE_TEMPLATE/release_issue.md
@@ -0,0 +1,32 @@
+---
+name: Tailpipe Release
+about: Tailpipe Release
+title: "Tailpipe v<INSERT_VERSION_HERE>"
+labels: release
+---
+
+#### Changelog
+
+[Tailpipe v<INSERT_VERSION_HERE> Changelog](https://github.com/turbot/tailpipe/blob/v<INSERT_VERSION_HERE>/CHANGELOG.md)
+
+## Checklist
+
+### Pre-release checks
+
+- [ ] All PR acceptance test pass in `tailpipe`
+- [ ] Update check is working
+- [ ] Tailpipe Changelog updated and reviewed
+
+### Release Tailpipe
+
+- [ ] Merge the release PR
+- [ ] Trigger the `01 - Tailpipe: Release` workflow. This will create the release build.
+
+### Post-release checks
+
+- [ ] Update Changelog in the Release page (copy and paste from CHANGELOG.md)
+- [ ] Test Linux install script
+- [ ] Test Homebrew install
+- [ ] Release branch merged to `develop`
+- [ ] Raise Changelog update to `tailpipe.io`, get it reviewed.
+- [ ] Merge Changelog update to `tailpipe.io`.
diff --git a/.github/workflows/01-tailpipe-release.yaml b/.github/workflows/01-tailpipe-release.yaml
@@ -0,0 +1,225 @@
+name: "01 - Tailpipe: Release"
+
+on:
+  workflow_dispatch:
+    inputs:
+      environment:
+        type: choice
+        description: 'Select Release Type'
+        options:
+        # to change the values in this option, we also need to update the condition test below in at least 3 location. Search for github.event.inputs.environment
+        - Development (alpha)
+        - Development (beta)
+        - Final (RC and final release)
+        required: true
+      version:
+        description: "Version (without 'v')"
+        required: true
+        default: 0.1.\invalid
+      confirmDevelop:
+        description: Confirm running on develop branch
+        required: true
+        type: boolean
+
+env:
+  TAILPIPE_UPDATE_CHECK: false
+  GH_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }}
+  SPIPETOOLS_TOKEN: ${{ secrets.SPIPETOOLS_TOKEN }}
+
+jobs:
+  ensure_branch_in_homebrew:
+    name: Ensure branch exists in homebrew-tap
+    runs-on: ubuntu-latest
+    steps:
+      - name: Calculate version
+        id: calculate_version
+        run: |
+          echo "VERSION=v${{ github.event.inputs.version }}" >> $GITHUB_ENV
+
+      - name: Parse semver string
+        id: semver_parser
+        uses: booxmedialtd/ws-action-parse-semver@v1
+        with:
+          input_string: ${{ github.event.inputs.version }}
+
+      - name: Checkout
+        if: steps.semver_parser.outputs.prerelease == ''
+        uses: actions/checkout@v4
+        with:
+          repository: turbot/homebrew-tap
+          token: ${{ secrets.GH_ACCESS_TOKEN }}
+          ref: main
+
+      - name: Delete base branch if exists
+        if: steps.semver_parser.outputs.prerelease == ''
+        run: |
+          git fetch --all
+          git push origin --delete tailpipe-brew
+          git push origin --delete $VERSION
+        continue-on-error: true
+
+      - name: Create base branch
+        if: steps.semver_parser.outputs.prerelease == ''
+        run: |
+          git checkout -b tailpipe-brew
+          git push --set-upstream origin tailpipe-brew
+
+  build_and_release:
+    name: Build and Release Tailpipe
+    needs: [ensure_branch_in_homebrew]
+    runs-on: ubuntu-latest
+    steps:
+      - name: validate
+        if: github.ref == 'refs/heads/develop'
+        env:
+          CONFIRM_MAIN: ${{ github.event.inputs.confirmDevelop }}
+        run: |
+          if [ "$CONFIRM_MAIN" == 'false' ]; then
+            echo "It looks like you've accidentally tried to run this action in develop branch. Either: "
+            echo " - Re-run the action and select the branch you wanted, or"
+            echo " - If you really do want to run this for develop, then re-run and tick the box to confirm"
+            exit 1
+          fi
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          path: tailpipe
+          ref: ${{ github.event.ref }}
+
+      - name: Checkout Pipe Fittings Components repository
+        uses: actions/checkout@v4
+        with:
+          repository: turbot/pipe-fittings
+          path: pipe-fittings
+          ref: develop
+
+      - name: Checkout Tailpipe plugin SDK repository
+        uses: actions/checkout@v4
+        with:
+          repository: turbot/tailpipe-plugin-sdk
+          path: tailpipe-plugin-sdk
+          token: ${{ secrets.GH_ACCESS_TOKEN }}
+          ref: develop
+
+      - name: Checkout Tailpipe Core Plugin repository
+        uses: actions/checkout@v4
+        with:
+          repository: turbot/tailpipe-plugin-core
+          path: tailpipe-plugin-core
+          token: ${{ secrets.GH_ACCESS_TOKEN }}
+          ref: develop
+
+      - name: Calculate version
+        id: calculate_version
+        run: |
+          if [ "${{ github.event.inputs.environment }}" = "Development (alpha)" ]; then
+            echo "VERSION=v${{ github.event.inputs.version }}-alpha.$(date +'%Y%m%d%H%M')" >> $GITHUB_ENV
+          elif [ "${{ github.event.inputs.environment }}" = "Development (beta)" ]; then
+            echo "VERSION=v${{ github.event.inputs.version }}-beta.$(date +'%Y%m%d%H%M')" >> $GITHUB_ENV
+          else
+            echo "VERSION=v${{ github.event.inputs.version }}" >> $GITHUB_ENV
+          fi
+
+      - name: Tag Release
+        run: |
+          cd tailpipe
+          git config user.name "Tailpipe GitHub Actions Bot"
+          git config user.email noreply@github.com
+          git tag $VERSION
+          git push origin $VERSION
+
+      # this is required, check golangci-lint-action docs
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.23'
+          cache: false # setup-go v4 caches by default, do not change this parameter, check golangci-lint-action doc: https://github.com/golangci/golangci-lint-action/pull/704
+
+      - name: Setup release environment
+        run: |-
+          cd tailpipe
+          echo 'GITHUB_TOKEN=${{secrets.GH_ACCESS_TOKEN}}' > .release-env
+
+      - name: Release publish
+        run: |-
+          cd tailpipe
+          make release
+
+  create_pr_in_homebrew:
+    name: Create PR in homebrew-tap
+    if: ${{ github.event.inputs.environment == 'Final (RC and final release)' }}
+    needs: [build_and_release]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Calculate version
+        id: calculate_version
+        run: |
+          echo "VERSION=v${{ github.event.inputs.version }}" >> $GITHUB_ENV
+
+      - name: Parse semver string
+        id: semver_parser
+        uses: booxmedialtd/ws-action-parse-semver@v1
+        with:
+          input_string: ${{ github.event.inputs.version }}
+
+      - name: Checkout
+        if: steps.semver_parser.outputs.prerelease == ''
+        uses: actions/checkout@v4
+        with:
+          repository: turbot/homebrew-tap
+          token: ${{ secrets.GH_ACCESS_TOKEN }}
+          ref: main
+
+      - name: Create a new branch off the base branch
+        if: steps.semver_parser.outputs.prerelease == ''
+        run: |
+          git fetch --all
+          git checkout tailpipe-brew
+          git checkout -b $VERSION
+          git push --set-upstream origin $VERSION
+
+      - name: Close pull request if already exists
+        if: steps.semver_parser.outputs.prerelease == ''
+        run: |
+          gh pr close $VERSION
+        continue-on-error: true
+
+      - name: Create pull request
+        if: steps.semver_parser.outputs.prerelease == ''
+        run: |
+          gh pr create --base main --head $VERSION --title "Tailpipe $VERSION" --body "Update formula"
+
+  update_pr_for_versioning:
+    name: Update PR
+    if: ${{ github.event.inputs.environment == 'Final (RC and final release)' }}
+    needs: [create_pr_in_homebrew]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Calculate version
+        id: calculate_version
+        run: |
+          echo "VERSION=v${{ github.event.inputs.version }}" >> $GITHUB_ENV
+
+      - name: Parse semver string
+        id: semver_parser
+        uses: booxmedialtd/ws-action-parse-semver@v1
+        with:
+          input_string: ${{ github.event.inputs.version }}
+
+      - name: Checkout
+        if: steps.semver_parser.outputs.prerelease == ''
+        uses: actions/checkout@v4
+        with:
+          repository: turbot/homebrew-tap
+          token: ${{ secrets.GH_ACCESS_TOKEN }}
+          ref: v${{ github.event.inputs.version }}
+
+      - name: Update live version
+        if: steps.semver_parser.outputs.prerelease == ''
+        run: |
+          scripts/formula_versioning_tailpipe.sh
+          git config user.name "Tailpipe GitHub Actions Bot"
+          git config user.email noreply@github.com
+          git add .
+          git commit -m "Versioning brew formulas"
+          git push origin $VERSION
diff --git a/.github/workflows/10-test-lint.yaml b/.github/workflows/10-test-lint.yaml
@@ -0,0 +1,57 @@
+name: "10 - Test: Linting"
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - main
+      - "v*"
+  workflow_dispatch:
+  pull_request:
+
+jobs:
+  golangci:
+    name: Test Linting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Tailpipe repository
+        uses: actions/checkout@v4
+        with:
+          path: tailpipe
+
+      - name: Checkout Pipe Fittings Components repository
+        uses: actions/checkout@v4
+        with:
+          repository: turbot/pipe-fittings
+          path: pipe-fittings
+          ref: tp
+
+      - name: Checkout Tailpipe plugin SDK repository
+        uses: actions/checkout@v4
+        with:
+          repository: turbot/tailpipe-plugin-sdk
+          path: tailpipe-plugin-sdk
+          token: ${{ secrets.GH_ACCESS_TOKEN }}
+          ref: develop
+
+      - name: Checkout Tailpipe Core Plugin repository
+        uses: actions/checkout@v4
+        with:
+          repository: turbot/tailpipe-plugin-core
+          path: tailpipe-plugin-core
+          token: ${{ secrets.GH_ACCESS_TOKEN }}
+          ref: develop
+
+      # this is required, check golangci-lint-action docs
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '1.23'
+          cache: false # setup-go v4 caches by default, do not change this parameter, check golangci-lint-action doc: https://github.com/golangci/golangci-lint-action/pull/704
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.61.0
+          args: --timeout=10m
+          working-directory: tailpipe
+          skip-cache: true