Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/peaceiris/actions-pixela

GitHub Actions for Pixela (a-know/pi) - a-know/pi Setup Action. Linux (Ubuntu), macOS, and Windows are supported.
https://github.com/peaceiris/actions-pixela

actions github-actions pixela

Last synced: 24 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/peaceiris/actions-pixela
Owner: peaceiris
License: mit
Archived: true
Created: 2019-05-07T02:44:20.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2022-03-26T02:06:01.000Z (about 2 years ago)
Last Synced: 2024-05-06T04:41:13.178Z (30 days ago)
Topics: actions, github-actions, pixela
Language: TypeScript
Homepage:
Size: 3.24 MB
Stars: 12
Watchers: 2
Forks: 2
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Lists

awesome-workflows - GitHub Actions for Pixela (a-know/pi)
awesome-actions - GitHub Actions for Pixela (a-know/pi)
awesome-actions - GitHub Actions for Pixela (a-know/pi)
awesome - GitHub Actions for Pixela (a-know/pi)
fucking-awesome-actions - GitHub Actions for Pixela (a-know/pi)
awesome-actions-fork - GitHub Actions for Pixela (a-know/pi)
awesome-actions - GitHub Actions for Pixela (a-know/pi)
awesome-actions - GitHub Actions for Pixela (a-know/pi)
awesome-actions - GitHub Actions for Pixela (a-know/pi)
awesome-actions - GitHub Actions for Pixela (a-know/pi)

README

        ## GitHub Actions for Pixela (a-know/pi)



- [Pixela | Record and Track your habits or effort. All by API.](https://pixe.la/)

- [a-know/pi: Official CLI tool for Pixela](https://github.com/a-know/pi)

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 | ✅️ | ✅️ | ✅️ |

[![license](https://img.shields.io/github/license/peaceiris/actions-pixela.svg)](https://github.com/peaceiris/actions-pixela/blob/main/LICENSE)

[![release](https://img.shields.io/github/release/peaceiris/actions-pixela.svg)](https://github.com/peaceiris/actions-pixela/releases/latest)

[![GitHub release date](https://img.shields.io/github/release-date/peaceiris/actions-pixela.svg)](https://github.com/peaceiris/actions-pixela/releases)

[![Test](https://github.com/peaceiris/actions-pixela/workflows/Test/badge.svg?branch=main&event=push)](https://github.com/peaceiris/actions-pixela/actions?query=workflow%3ATest)

[![CodeFactor](https://www.codefactor.io/repository/github/peaceiris/actions-pixela/badge)](https://www.codefactor.io/repository/github/peaceiris/actions-pixela)

[![codecov](https://codecov.io/gh/peaceiris/actions-pixela/branch/main/graph/badge.svg)](https://codecov.io/gh/peaceiris/actions-pixela)

[![Release Feed](https://img.shields.io/badge/release-feed-yellow)](https://github.com/peaceiris/actions-pixela/releases.atom)

## Table of Contents

- [Getting started](#getting-started)

  - [Add Pixela User Token](#add-pixela-user-token)

  - [Example Workflow](#example-workflow)

  - [Matrix build](#matrix-build)

- [Example Graphs](#example-graphs)

- [CHANGELOG](#changelog)

- [License](#license)

- [About Maintainer](#about-maintainer)

- [Maintainer Notes](#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`

```yaml

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  -g 

```

### Matrix build

```yaml

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  -g '${{ matrix.graph_id }}'

```



Back to TOC ☝️



## Example Graphs

*CI Test on Linux Passed*

[![GitHub Actions for Pixela CI Linux](https://pixe.la/v1/users/peaceiris/graphs/gha-pi-ci-linux)](https://pixe.la/v1/users/peaceiris/graphs/gha-pi-ci-linux.html)

*CI Test on macOS Passed*

[![GitHub Actions for Pixela CI macOS](https://pixe.la/v1/users/peaceiris/graphs/gha-pi-ci-macos)](https://pixe.la/v1/users/peaceiris/graphs/gha-pi-ci-macos.html)

*CI Test on Windows Passed*

[![GitHub Actions for Pixela CI Windows](https://pixe.la/v1/users/peaceiris/graphs/gha-pi-ci-win)](https://pixe.la/v1/users/peaceiris/graphs/gha-pi-ci-win.html)



Back to TOC ☝️



## CHANGELOG

- [CHANGELOG.md](CHANGELOG.md)

## License

- [MIT License - peaceiris/actions-pixela]

[MIT License - peaceiris/actions-pixela]: https://github.com/peaceiris/actions-pixela/blob/main/LICENSE

## About Maintainer

- [peaceiris homepage](https://peaceiris.com/)

## Maintainer Notes

Run `npm` and `git commit` commands on a container.

**On Host**

```sh

# Docker

make build

make run

make run cmd="env"

make test

make commit msg="chore: Add Makefile"

# Release

./release.sh

```



Back to TOC ☝️