<Mazipan />

GitHub Actions Summary

#gh-actions

Pekerjaan saya sehari-hari beberapa kali memang harus bersinggungan dengan CI, termasuk dengan GitHub Actions.

Nah ada kabar terbaru bulan lalu mengenai Actions Summary (Baca: Supercharging GitHub Actions with Job Summaries).

Sekilas melihat sih wow, sepertinya akan memudahkan untuk melihat rangkuman hasil dari sebuah workflow yang jalan tanpa perlu melakukan klik tambahan ke dalam detail log nya ya. Hmmm, markicob…

Jadi, ada dua cara paling tidak untuk membuat Actions Summary ini:

  • 1️⃣ Cukup dengan menulis ke environment variable yang telah di sediakan:
steps:
  - name: Adding markdown
    run: echo '### Hello world! :rocket:' >> $GITHUB_STEP_SUMMARY

Kita cukup menulis apapun kontennya, ke env $GITHUB_STEP_SUMMARY. Contoh di atas menggunakan kode shell script seperti biasa.

  • 2️⃣ Menggunakan bantuan helper @actions/core

Seperti yang kalian mungkin sudah tau, kita bisa menggunakan berbagai bantuan dari pustaka @actions/core untuk berinteraksi terhadap berbagai fitur yang telah disediakan dalam GitHub Actions.

import * as core from '@actions/core'
  await core.summary
  .addHeading('Test Results')
  .addCodeBlock(generateTestResults(), "js")
  .addTable([
    [{data: 'File', header: true}, {data: 'Result', header: true}],
    ['foo.js', 'Pass '],
    ['bar.js', 'Fail '],
    ['test.js', 'Pass ']
  ])
  .addLink('View staging deployment!', 'https://github.com')
  .write()

Hmmm, sekilas melihat sepertinya saya pribadi tidak akan nyaman menggunakan @actions/core 🥶.

Saya sebelumnya memiliki repo psi-gh-action, jadi saya sekalian aja belajar mengenai ini di repo pribadi.

Jika sebelumnya saya harus masuk ke log dari workflow untuk melihat rangkuman hasilnya:

Sebelum menggunakan Actions Summary
Sebelum menggunakan Actions Summary

Setelah menggunakan Action Summary saya bisa langsung melihat dari halaman depan workflow tersebut:

Setelah menggunakan Actions Summary
Setelah menggunakan Actions Summary

Dan tebak, kodenya cuma sesederhana ini aja:

const { execSync } = require('child_process')
const { blue, red } = require('../logger')

exports.setActionSummary = async function setActionSummary ({ commentBody }) {
  try {
    blue('> Creating Action summary...')
    execSync(`echo '${commentBody}' >> $GITHUB_STEP_SUMMARY`)
  } catch (error) {
    red(error)
  }
}

Tentu dengan catatan, saya sebelumnya harus membuat markdown string yang akan dikirimkan.

Mudah ya, calon bisa diaplikasikan ke berbagai workflow lainnya nih.

Btw, detail kodenya bisa disimak di commit 32d4a3d, commit-nya berantakan karena sekalian mindah-mindahin dan upgrade versi beberapa dependency yang diperlukan biar lebih oke.

🌟 Thank you for reading
© 2019-2022, All rights reserved