Giter VIP home page Giter VIP logo

check-commands's Introduction

Check minecraft commands

GitHub release (latest SemVer) Discord

Github action to validate minecraft data packs and function files.

# .github/workflows/check-commands.yml
name: Check commands
on: [push]

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: mcbeet/check-commands@v1
        with:
          source: path/to/my_data_pack

Usage

This github action installs mecha in an isolated virtualenv and checks your data pack and function files for errors. The inputs of the action reflect the mecha command-line options. Only the source input is required.

Input Optional Description
version defaults to latest The version of mecha to install
source required The list of data packs, functions files or folders to validate
minecraft defaults to 1.19 The version of minecraft to use for checking commands
stats defaults to false Whether to output statistics
log defaults to WARNING The output log level

Examples

Check a data pack when the pack.mcmeta file is at the root of the repository.

- uses: mcbeet/check-commands@v1
  with:
    source: .

Check a data pack located in the src directory.

- uses: mcbeet/check-commands@v1
  with:
    source: src

Check individual function files.

- uses: mcbeet/check-commands@v1
  with:
    source: foo.mcfunction bar.mcfunction

Check a data pack at the root of the repository with an explicit minecraft version.

- uses: mcbeet/check-commands@v1
  with:
    source: .
    minecraft: "1.18"

Check a data pack at the root of the repository and output statistics.

- uses: mcbeet/check-commands@v1
  with:
    source: .
    stats: true

Contributing

Contributions are welcome. Make sure to first open an issue discussing the problem or the new feature before creating a pull request. If you find a bug please try to share a link to the problematic action run.


License - MIT

check-commands's People

Contributors

vberlier avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

check-commands's Issues

GITHUB_TOKEN permissions used by this action

At https://github.com/step-security/secure-workflows we are building a knowledge-base (KB) of GITHUB_TOKEN permissions needed by different GitHub Actions. When developers try to set minimum token permissions for their workflows, they can use this knowledge-base instead of trying to research permissions needed by each GitHub Action they use.

Below you can see the KB of your GITHUB Action.

name: Check minecraft commands # mcbeet/check-commands
# GITHUB_TOKEN not used

If you think this information is not accurate, or if in the future your GitHub Action starts using a different set of permissions, please create an issue at https://github.com/step-security/secure-workflows/issues to let us know.

This issue is automatically created by our analysis bot, feel free to close after reading :)

References:

GitHub asks users to define workflow permissions, see https://github.blog/changelog/2021-04-20-github-actions-control-permissions-for-github_token/ and https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token for securing GitHub workflows against supply-chain attacks.

Setting minimum token permissions is also checked for by Open Source Security Foundation (OpenSSF) Scorecards. Scorecards recommend using https://github.com/step-security/secure-workflows so developers can fix this issue in an easier manner.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.