peaceiris / actions-pixela

GitHub Actions for Pixela (a-know/pi) - a-know/pi Setup Action. Linux (Ubuntu), macOS, and Windows are supported.

GitHub Actions for Pixela (a-know/pi)

• Pixela | Record and Track your habits or effort. All by API.
• a-know/pi: Official CLI tool for Pixela

This Pixela Setup Action can install a-know/pi to a virtual machine of GitHub Actions. Linux (Ubuntu), macOS, and Windows are supported.

OS (runs-on)	ubuntu-18.04	macos-latest	windows-latest
Support	✅️	✅️	✅️

Table of Contents

• Getting started
  • Add Pixela User Token
  • Example Workflow
  • Matrix build
• Example Graphs
• CHANGELOG
• License
• About Maintainer
• Maintainer Notes

Getting started

Add Pixela User Token

1. Go to Settings > Secrets.
2. Add your PIXELA_USER_TOKEN as a new secret.

Example Workflow

Workflow file: .github/workflows/pixela.yml

name: pixela

on:
  push:
    branches:
      - main

jobs:
  increment:
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v2

      - name: Setup a-know/pi
        uses: peaceiris/actions-pixela@v2
        with:
          pi_version: '1.2.0'

      - name: Increment
        env:
          PIXELA_USER_TOKEN: ${{ secrets.PIXELA_USER_TOKEN }}
        run: |
          pi pixel increment -u <username> -g <graph-id>

Matrix build

name: 'Test'

on:
  push:
    branches:
      - main

jobs:
  test:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os:
          - 'ubuntu-18.04'
          - 'macos-latest'
          - 'windows-latest'
        include:
          - os: 'ubuntu-18.04'
            graph_id: 'gha-pi-ci-linux'
          - os: 'macos-latest'
            graph_id: 'gha-pi-ci-macos'
          - os: 'windows-latest'
            graph_id: 'gha-pi-ci-win'
    steps:
      - uses: actions/checkout@v2

      - name: Setup pi
        uses: peaceiris/actions-pixela@v2
        with:
          pi_version: '1.2.0'

      - name: Increment
        env:
          PIXELA_USER_TOKEN: ${{ secrets.PIXELA_USER_TOKEN }}
        run: |
          pi pixel increment -u <username> -g '${{ matrix.graph_id }}'

Back to TOC ☝️

Example Graphs

CI Test on Linux Passed

CI Test on macOS Passed

CI Test on Windows Passed

Back to TOC ☝️

CHANGELOG

• CHANGELOG.md

License

• MIT License - peaceiris/actions-pixela

About Maintainer

• peaceiris homepage

Maintainer Notes

Run npm and git commit commands on a container.

On Host

# Docker
make build
make run
make run cmd="env"
make test
make commit msg="chore: Add Makefile"

# Release
./release.sh

Back to TOC ☝️