Git Product home page Git Product logo

Comments (7)

chrispat avatar chrispat commented on June 11, 2024

packages/toolkit contains a reference to the octokit/rest package which not all actions need. Perhaps we need a better name for that package that indicates it is primarily designed for working with the GitHub rest api.

from toolkit.

bryanmacfarlane avatar bryanmacfarlane commented on June 11, 2024

@chrispat - right - that's important. In our previous discussions, we discussed calling that package github (since it's all about github interactions and context). Outside of that, moving exit to core is the other thing that seems right since how you exit an exit seems like a core concept. Either that or we break out other core actions as separate packages - just looking for consistency.

from toolkit.

bryanmacfarlane avatar bryanmacfarlane commented on June 11, 2024

I'm going to let @damccorm create a proposal as a PR and then we can iterate from there. I think this issue and previous discussions capture what we need to do.

from toolkit.

chrispat avatar chrispat commented on June 11, 2024

I know we went through a set of design discussions early on and this is what we had decided on. However, it does feel like we have some extra packages that don't layer particularly well.

All types of actions whether for SDLC or CI/CD will likely need the core and exit functionality for logging and indicating their exit status. Given that I think it makes the most sense to merge exit into core. Also, neither core nor exit stands on their own outside of an action.

After that, we have some utility packages that help out with running tools (exec) and common GNU file operations (io). For the most part, these feel like general utility packages that could stand on their own outside of GitHub actions.

toolkit adds an exit package that really just adds some additional logging. If we find that useful let's just make that part of exit in core.

There is a smattering of other stuff in tool kit around easy running of an async function and required environment variables that feel like they should just be part of core.

The last piece that is there is the octokit api. I think we should have a package called actions/github that makes it easy to get an authenticated client based in the GITHUB_TOKEN secret.

from toolkit.

vtbassmatt avatar vtbassmatt commented on June 11, 2024

This all sounds good to me. I think we should get @jclem to weigh in, and assuming no issues, ship it. I'm (im)patiently waiting to get the tarballs out of the template repo and into GPR :)

from toolkit.

bryanmacfarlane avatar bryanmacfarlane commented on June 11, 2024

Yep, @jclem and I already had a discussion.

from toolkit.

damccorm avatar damccorm commented on June 11, 2024

Closing here since #21 has been merged. #23 is follow up work

from toolkit.

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.