mirror of
https://github.com/nektos/act.git
synced 2026-04-26 01:15:51 +03:00
Page:
Act v2 spec proposal
No results
1
Act v2 spec proposal
Ryan edited this page 2022-03-17 13:05:23 +01:00
Table of Contents
CLI
act:
- config file
actrc/SetArgs()- there is no need to remove it, can be incorporated into v2- YAML - popular and first-class support in Go, DRY(!), same syntax as GitHub Actions workflows/actions but sensitive about spaces and spec is huge!
- flags
--machine-readable(or already existing--json?) - provide flag to output in a format that other software can consume, rationale: others building uponactwant to parse stuff but also it can be used to provide advanced completions, e.g.:act -W<tab> .github/workflows/test.yml--container-daemon-*or--container-engine-*- flags to control Docker Engine API-compatible daemons- normalize flags
--dryrun->--dry-run--event-path->--event-file-path--userns->--container-{daemon,egnine}-userns--defaultbranch->--default-branch--privileged->--container-{daemon,egnine}-privileged- flags disabling a feature or functionality should be in format of
--no-*and make it clear when making new flags, a.k.a follow the unwritten standard of cli opt (examples: https://no-color.org/,grep,file, etc.)-
--include-*,--exclude-*, etc. where possible
-
--event-type- specify event type that triggers workflows (push,pull_request,workflow_dispatch, etc.)
- subcommands
run- execute workflowagent- run as GitHub Actions runner agentconfig- generalised interface for configuringactcompletions- generate completions for shells, helpful for users and package maintainers- suggestions?
- Would we like to replace
logrus?- pros:
logrusis most popular logger for Go - cons: it's in maintenance mode, therefore no new features but also bugfixes are cumbersome (https://pkg.go.dev/github.com/sirupsen/logrus#Ext1FieldLogger ????)
- pros:
This wiki is obsolete please use the Act User Guide aka https://nektosact.com
This wiki is obsolete please use the Act User Guide aka https://nektosact.com