Skip to content

raphaelstolt/lean-package-validator-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LeanPackageValidator GitHub Action

The LeanPackageValidator GitHub Action is utilising the LeanPackage Validator, which can validate a project/micro-package for its leanness. A project/micro-package is considered lean when its common repository artifacts/dotfiles like .editorconfig, /tests, ... , won't be included in the release assets.

Usage

Check the Git repository's .gitattribute against a .lpv file in the Git repository under continuous integration. A .lpv stores the glob pattern used for validating a .gitattribute file and should be committed in the Git repository under continuous integration.

... omitted job configuration
        strategy:
            fail-fast: true
            matrix:
                php:
                    - "8.1"
        steps:
            -   name: Check leanness of package
                uses: raphaelstolt/lean-package-validator-action@v<version>
                with:
                    php-version: "${{ matrix.php }}"
                    lpv-version: "4.0.2"

Check the Git repository's .gitattribute against a glob pattern e.g. for Python projects and have some more verbose output.

... omitted job configuration
        strategy:
            fail-fast: true
            matrix:
                php:
                    - "8.1"
        steps:
            -   name: Check leanness of package
                uses: raphaelstolt/lean-package-validator-action@v<version>
                with:
                    php-version: "${{ matrix.php }}"
                    lpv-version: "4.0.2"
                    glob-pattern: '{.*,*.rst,*.py[cod],dist/}'
                    verbose: true

License

This GitHub Action is licensed under the MIT license. Please see LICENSE.md for more details.

Changelog

Please see CHANGELOG.md for more details.

About

A GitHub Action that validates a project/micro-package for its leanness.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages