README
¶
Overview 
"Think globally,
actlocally"
Run your GitHub Actions locally! Why would you want to do this? Two reasons:
- Fast Feedback - Rather than having to commit/push every time you want to test out the changes you are making to your
.github/workflows/files (or for any changes to embedded GitHub actions), you can useactto run the actions locally. The environment variables and filesystem are all configured to match what GitHub provides. - Local Task Runner - I love make. However, I also hate repeating myself. With
act, you can use the GitHub Actions defined in your.github/workflows/to replace yourMakefile!
[!TIP] Now Manage and Run Act Directly From VS Code!
Check out the GitHub Local Actions Visual Studio Code extension which allows you to leverage the power ofactto run and test workflows locally without leaving your editor.
How Does It Work?
When you run act it reads in your GitHub Actions from .github/workflows/ and determines the set of actions that need to be run. It uses the Docker API to either pull or build the necessary images, as defined in your workflow files and finally determines the execution path based on the dependencies that were defined. Once it has the execution path, it then uses the Docker API to run containers for each action based on the images prepared earlier. The environment variables and filesystem are all configured to match what GitHub provides.
Let's see it in action with a sample repo!
Act User Guide
Please look at the act user guide for more documentation.
Support
Need help? Ask in discussions!
Contributing
Want to contribute to act? Awesome! Check out the contributing guidelines to get involved.
Manually building from source
- Install Go tools 1.20+ - (https://golang.org/doc/install)
- Clone this repo
git clone git@github.com:nektos/act.git - Run unit tests with
make test - Build and install:
make install
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
config-validator
command
Package main provides a configuration validation tool for Ephemos.
|
Package main provides a configuration validation tool for Ephemos. |
|
ephemos-cli
command
Package main provides the Ephemos CLI tool for production SPIFFE/SPIRE service management and identity-based authentication administration.
|
Package main provides the Ephemos CLI tool for production SPIFFE/SPIRE service management and identity-based authentication administration. |
|
test-errorx
command
|
|
|
internal
|
|
|
adapters/grpc
Package grpc provides gRPC transport adapters for domain services.
|
Package grpc provides gRPC transport adapters for domain services. |
|
adapters/http
Package http provides HTTP transport adapters for domain services.
|
Package http provides HTTP transport adapters for domain services. |
|
adapters/interceptors
Package interceptors provides built-in gRPC interceptors for authentication and identity propagation.
|
Package interceptors provides built-in gRPC interceptors for authentication and identity propagation. |
|
adapters/logging
Package logging provides secure logging utilities with automatic redaction of sensitive data.
|
Package logging provides secure logging utilities with automatic redaction of sensitive data. |
|
adapters/primary/api
Package api provides high-level client and server APIs for secure SPIFFE-based communication.
|
Package api provides high-level client and server APIs for secure SPIFFE-based communication. |
|
adapters/primary/cli
Package cli provides command-line interface implementations for Ephemos
|
Package cli provides command-line interface implementations for Ephemos |
|
adapters/secondary/config
Package config provides configuration management for Ephemos.
|
Package config provides configuration management for Ephemos. |
|
adapters/secondary/memidentity
Package memidentity provides an in-memory fake IdentityProvider for testing.
|
Package memidentity provides an in-memory fake IdentityProvider for testing. |
|
adapters/secondary/spiffe
Package spiffe provides SPIFFE identity management and X.509 certificate handling.
|
Package spiffe provides SPIFFE identity management and X.509 certificate handling. |
|
adapters/secondary/transport
Package transport provides enhanced gRPC connection management with backoff and retry policies.
|
Package transport provides enhanced gRPC connection management with backoff and retry policies. |
|
arch
Package arch provides runtime architectural boundary validation.
|
Package arch provides runtime architectural boundary validation. |
|
cli
Package cli provides command-line interface for Ephemos.
|
Package cli provides command-line interface for Ephemos. |
|
contract/configurationprovider
Package configurationprovider provides contract test suites for ConfigurationProvider implementations.
|
Package configurationprovider provides contract test suites for ConfigurationProvider implementations. |
|
contract/identityprovider
Package identityprovider provides contract test suites for IdentityProvider implementations.
|
Package identityprovider provides contract test suites for IdentityProvider implementations. |
|
contract/transportprovider
Package transportprovider provides contract test suites for TransportProvider implementations.
|
Package transportprovider provides contract test suites for TransportProvider implementations. |
|
core/domain
Package domain handles service identity and authentication policies.
|
Package domain handles service identity and authentication policies. |
|
core/errors
Package errors defines custom error types for the Ephemos library
|
Package errors defines custom error types for the Ephemos library |
|
core/ports
Package ports defines interfaces for core services and domain boundaries.
|
Package ports defines interfaces for core services and domain boundaries. |
|
core/services
Package services provides core business logic services.
|
Package services provides core business logic services. |
|
pkg
|
|
|
ephemos
Package ephemos provides early config validation integrated into high-level API entry points.
|
Package ephemos provides early config validation integrated into high-level API entry points. |
|
scripts
|
|
|
security/go
command
|
Click to show internal directories.
Click to hide internal directories.