Feat(update): Added Job summary for lint.yml workflow

.github/workflows/lint.yml

@@ -1,53 +1,97 @@
 name: "Lint"
-
 on:
  workflow_call:
-
 permissions:
  contents: read
  pull-requests: read
-
 jobs:
  ts-lint:
- # TODO(JayF): Determine what nodejs versions we target, and setup matrix-based testing similar to what we do for go
  name: Lint TypeScript
  runs-on: ubuntu-22.04
-
  steps:
- - name: Checkout
+ - name: Adding markdown for Typescript
+ run: echo '### Lint TypeScript ✨' >> $GITHUB_STEP_SUMMARY
+ - name: Checkout 
  uses: actions/checkout@v3.3.0
-
- - name: Setup Node
+ - name: Setup Node 
  uses: actions/setup-node@v3
  with:
  node-version: 16.14.2
  cache: yarn
  cache-dependency-path: ./internal/lookout/ui/yarn.lock
-
- - name: Check TypeScript formatting
+ - name: Check TypeScript formatting 
+  id: ts-lint
  run: |
- yarn install --frozen-lockfile && yarn run fmt || exit 1
+ yarn install --frozen-lockfile && yarn run fmt > lint_results.txt || exit 0
+ echo "::set-output name=lint_results::$(cat lint_results.txt)"
  exit $(git status -s -uno | wc -l)
  working-directory: ./internal/lookout/ui
-
+ - name: Generate list using Markdown
+ id: ts-lint-summary
+ run: |
+ if [ ${{ steps.ts-lint.outcome }} == 'success' ]; then
+ echo "- ✔️ Checked out the repository" >> $GITHUB_STEP_SUMMARY
+ echo "- ✔️ Set up Node.js with version 16.14.2 and cached Yarn dependencies" >> $GITHUB_STEP_SUMMARY
+ echo "- ✔️ Checked TypeScript formatting" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "- ❌ Checked out the repository" >> $GITHUB_STEP_SUMMARY
+ echo "- ❌ Set up Node.js with version 16.14.2 and cached Yarn dependencies" >> $GITHUB_STEP_SUMMARY
+ echo "- ❌ TypeScript formatting check failed" >> $GITHUB_STEP_SUMMARY
+ echo "::error::Linting issues found. Check the details below." >> $GITHUB_STEP_SUMMARY
+ cat lint_results.txt >> $GITHUB_STEP_SUMMARY
+ fi
+ continue-on-error: true
  go-lint:
  name: Lint Go
  runs-on: ubuntu-22.04
-
  steps:
- - name: Checkout
+ - name: Adding markdown
+ run: echo '### Lint Go ✨' >> $GITHUB_STEP_SUMMARY
+ - name: Checkout 
  uses: actions/checkout@v3.3.0
-
- - name: Setup Golang with Cache
+ - name: Setup Golang with Cache 
  uses: magnetikonline/action-golang-cache@v4
  with:
  go-version: "1.20"
-
- - name: Lint using golangci-lint
+ - name: Lint using golangci-lint 
+  id: go-lint
  uses: golangci/golangci-lint-action@v3
  with:
  skip-pkg-cache: true
  skip-build-cache: true
  version: v1.52.2
  only-new-issues: true
  args: --timeout=10m --issues-exit-code=1 --sort-results ./...
+
+ - name: Save Go linting results
+ if: ${{ always() }}
+ run: |
+ echo "GolangCI-Lint Results:" > lint_results.txt
+ echo "\`\`\`" >> lint_results.txt
+ echo "${{ steps.go-lint.outputs.stdout }}" >> lint_results.txt
+ echo "\`\`\`" >> lint_results.txt
+ cat lint_results.txt
+ continue-on-error: true 
+
+ - name: Generate list using Markdown
+ id: go-lint-summary
+ run: |
+ if [ ${{ steps.go-lint.outcome }} == 'success' ]; then
+ echo "- ✔️ Checked out the repository" >> $GITHUB_STEP_SUMMARY
+ echo "- ✔️ Set up Go with version 1.20 and cached dependencies" >> $GITHUB_STEP_SUMMARY
+ echo "- ✔️ Linted Go code using golangci-lint" >> $GITHUB_STEP_SUMMARY
+ else
+ echo "- ❌ Checked out the repository" >> $GITHUB_STEP_SUMMARY
+ echo "- ❌ Set up Go with version 1.20 and cached dependencies" >> $GITHUB_STEP_SUMMARY
+ echo "- ❌ Go lint check failed" >> $GITHUB_STEP_SUMMARY
+ echo "::error::Linting issues found. Check the details below." >> $GITHUB_STEP_SUMMARY
+ while read -r line; do
+ file=$(echo "$line" | cut -d':' -f1)
+ linenum=$(echo "$line" | cut -d':' -f2)
+ message=$(echo "$line" | cut -d':' -f4-)
+ echo "::error file=$file,line=$linenum::${message}" >> $GITHUB_STEP_SUMMARY
+ done < lint_results.txt
+ fi
+ continue-on-error: true
+ if: always()
+

internal/lookout/application.go

@@ -19,6 +19,10 @@
  "github.com/armadaproject/armada/pkg/api/lookout"
 )
 
+func exampleFunction() {
+ // Lint issue: Empty block, this should have some code.
+}
+
 type LogRusLogger struct{}
 
 func (l LogRusLogger) Printf(format string, v ...interface{}) {