sharknoon/umbrel-app-linter-action

This is a small GitHub Action for linting umbrelOS apps

Umbrel App Linter

A GitHub Action that checks your umbrelOS Apps for issues and provides fixes.

Linting apps on Pull Requests

When using Pull Requests, this action automatically detects the changed files and lints them.

The linting result will be published as annotations, a job summary and a Pull Request comment.

name: CI

on:
  pull_request:
    branches:
      - main

jobs:
  lint-apps:
    name: Lint apps
    runs-on: ubuntu-latest
    steps:
      - uses: sharknoon/umbrel-app-linter-action@v1

Linting apps on every other event

You need to specify the base branch or commit hash as well as the head commit hash (no branch name!) to compare those two git refs. This way the linter determines the changed files.

You can also supply a custom GitHub Token, if you need special permissions.

The linting result will be published as annotations and a job summary.

name: CI

on:
  push:
    branches:
      - main

jobs:
  lint-apps:
    name: Lint apps
    runs-on: ubuntu-latest
    steps:
      - uses: sharknoon/umbrel-app-linter-action@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          base: "main"
          head-sha: ${{ github.sha }}

Development

Install dependencies with

npm i

Create production build with

npm run build

To publish a new version

1. Push your changes to GitHub using git commit -m "new version" and git push
2. Create a new Release here