Learning how to get Console output from Actions in GitHub

Learning how to get Console output from Actions in GitHub

The console output in GitHub Actions provides real-time logs of the execution of workflows, jobs, and steps. This output is invaluable for debugging, monitoring progress, and understanding the results of your automation.

Where to View Console Output

1. Actions Tab:

   • Navigate to the Actions tab in your GitHub repository.

   • Select the workflow run you want to inspect.

   • Click on the job name to view its steps and corresponding console output.

2. Log Hierarchy:

   • Workflow Level: Shows the overall status of the workflow.

   • Job Level: Lists all jobs with their completion status (e.g., success, failure).

   • Step Level: Provides detailed logs for each step, including commands run, actions used, and any errors.

Components of Console Output

1. Workflow Information

Displays the workflow's name, trigger event, and run number.

Example:

xxxxxxxxxx
3
1
Workflow: CI Workflow
2
Triggered by: push
3
Run #123

2. Job Logs

• Shows the environment (runner) and setup information.

• Includes metadata about job start and end times.

3. Step Logs

Each step’s output is listed in the order of execution.

Example:

xxxxxxxxxx
2
1
Run echo "Starting Build"
2
Starting Build

4. Commands and Actions

Commands (run) and GitHub Actions (uses) produce their own outputs.

Example:

xxxxxxxxxx
2
1
steps:
2
   - run: echo "Deploying to staging environment"

Console output:

xxxxxxxxxx
1
1
Deploying to staging environment

5. Errors and Failures

Errors are displayed with clear messages, often marked in red.

Example:

xxxxxxxxxx
1
1
Error: Command failed with exit code 1

Debugging with Console Output

1. Enable Debug Logging

For additional details:

• Set the ACTIONS_STEP_DEBUG secret to true.

• Example in workflow:

xxxxxxxxxx
2
1
env:
2
  ACTIONS_STEP_DEBUG: true

Console output includes detailed logs:

xxxxxxxxxx
1
1
::debug::Installing dependencies

2. Mask Sensitive Data

To protect sensitive information, GitHub automatically masks secrets in the logs:

Example:

xxxxxxxxxx
1
1
Deploying with API key: **

3. Using the :: Syntax

Special syntax allows writing custom messages in the logs:

• Annotations (warnings or errors):

  xxxxxxxxxx
  1
  1
  echo "::warning file=app.js,line=10::Deprecated function"
  

• Console output:

  xxxxxxxxxx
  1
  1
  Warning: Deprecated function
  

• Debug Messages:

  xxxxxxxxxx
  1
  1
  echo "::debug::Starting deployment"
  

• Errors:

  xxxxxxxxxx
  1
  1
  echo "::error::Build failed"
  

Customizing Console Output

1. Grouping Logs

Group related logs for better readability:

xxxxxxxxxx
6
1
steps:
2
   - name: Setup
3
    run: |
4
      echo "::group::Installing dependencies"
5
      npm install
6
      echo "::endgroup::"

Console output:

xxxxxxxxxx
2
1
> Installing dependencies
2
npm install logs...

2. Adding Timestamps

Add timestamps to logs for precise execution tracking:

xxxxxxxxxx
2
1
steps:
2
   - run: echo "$(date) - Starting process"

3. Storing and Uploading Logs

Save logs as artifacts for later review:

xxxxxxxxxx
9
1
steps:
2
   - name: Save Logs
3
    run: |
4
      mkdir -p logs
5
      echo "Log data" > logs/output.txt
6
   - uses: actions/upload-artifact@v3
7
    with:
8
      name: build-logs
9
      path: logs/output.txt

Example Console Output

1. Workflow YAML

xxxxxxxxxx
15
1
name: CI Workflow
2
on:
3
  push:
4
    branches:
5
     - main
6
jobs:
7
  build:
8
    runs-on: ubuntu-latest
9
    steps:
10
     - name: Checkout Code
11
        uses: actions/checkout@v3
12
     - name: Install Dependencies
13
        run: npm install
14
     - name: Run Tests
15
        run: npm test

2. Console Output

xxxxxxxxxx
14
1
==> Starting job: build
2
Using runner: ubuntu-latest
3

4
Step 1: Checkout Code
5
Cloning repository...
6
Cloned successfully.
7

8
Step 2: Install Dependencies
9
npm install logs...
10
Dependencies installed.
11

12
Step 3: Run Tests
13
Test output...
14
Tests completed successfully.

Common Debugging Scenarios

1. Failed Steps:

   • Identify the failed step and examine its logs for error messages.

   • Reproduce the issue locally using the same commands.

2. Silent Failures:

   • Enable ACTIONS_STEP_DEBUG to see hidden details.

   • Check for missing dependencies or incorrect environment variables.

3. Performance Issues:

   • Use timestamps to measure execution time for each step.

   • Look for bottlenecks in installation or build processes.

Summary

The console output is a vital tool for monitoring, debugging, and optimizing GitHub Actions workflows.