saadmk11 / github-action-utils Goto Github PK

Misplaced call to .encode() method leading to unusable output.

Issue in Changlog client
saadmk11/changelog-ci#94

Thank you for these utils!

I see that ::set-output is still used:
https://github.com/saadmk11/github-action-utils/blob/main/github_action_utils.py#L152

More info about the deprecation and the solution here:

• https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
• https://hynek.me/til/set-output-deprecation-github-actions/

If you fix this and publish a new release, I will be glad to start using this library!

If I'm developing a script that runs either locally or in github action, I may want to detect whether it is running in github action environment, because some functions in github-action-utils is unusable locally.
Although I can detect the environment by using try-catch, I still want a more Pythonic solution in the github-action-utils module. For example, a is_github_action() function that returns a bool.

Hi,

I'm thinking about a dataclass containing all the default variables like

from github_action_utils import vars
# vars.ci == True
# vars.github.event_path == '/github/workflow/event.json'

and so on. So every first _ in a variable name would actually open a new sub-level.
All values would be read-only. With appropriate __doc__ strings this would allow for great integration in any IDE.

The goal would be to reduce boilerplate code like

GITHUB = {
    "SERVER_URL": github_action_utils.get_env("GITHUB_SERVER_URL"),
    "REPOSITORY": github_action_utils.get_env("GITHUB_REPOSITORY"),
    "RUN_NUMBER": github_action_utils.get_env("GITHUB_RUN_NUMBER"),
}

Opinions?

You need a py.typed file to indicate to pyright and other type checkers that the library is typed: https://github.com/microsoft/pyright/blob/main/docs/typed-libraries.md#library-interface

Also, an __all__ would be very nice, even if this is a single module package!