Coder Social home page Coder Social logo

Comments (2)

rhysd avatar rhysd commented on July 21, 2024

Good point. actionlint currently types github.event as an object which accepts any properties.

It's possible to give stricter type to github.event. But it is a bit challenging in the following points:

  • there are so many properties under github.event. Crafting the type definition is a bit hard.
  • The event payloads are depending on GitHub API specification, meant that they would change at some point in the future.

My idea is preparing a script to generate a Go code for the type of github.event and generating a code regularly. We already do this for popular_actions.go and all_webhooks.go. I think we can do the similar thing for the type definition of github.event payload.

Octokit maintains payloads information at https://github.com/octokit/webhooks. We might be able to use it.

from actionlint.

rhysd avatar rhysd commented on July 21, 2024

Properties other than github.event.* are already typed strictly following the official document (e.g. runner.tmp). So I believe the remaining payloads which are not typed well are only github.event.*. Let me update the title more specifically.

from actionlint.

Related Issues (20)

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.