README
¶
Step Runner
Step Runner is an RFC implementation for GitLab Steps, a CI/CD feature to define and use reusable components within a single job execution context. See HOWTO.md for usage.
Project status
Step Runner is currently an experimental feature. It can be tested in GitLab CI/CD jobs but should not be used for production workloads yet.
- Demo: https://youtu.be/TU_53vWVKeE
- Code: https://gitlab.com/josephburnett/hello-step-runner
- Feedback: https://gitlab.com/gitlab-org/step-runner/-/issues/10
- Blueprint: https://docs.gitlab.com/ee/architecture/blueprints/gitlab_steps/
Contributing
Contributions are welcome, see CONTRIBUTING.md for more details.
Project License
You can view this projects license in LICENSE.
Release
During the experimental phase all changes to main are automatically built as a Docker image and tagged in the container repository as v0.
So any workflows referencing the image always use the latest version of the code, and behavior could change at any time.
See HOWTO.md for an example of how to test the Step Runner in a job by using the container image.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
api/client/basic
package basic implements a low-level client for the step-runner gRPC service with a (more or less) 1:1 mapping to the raw gRPC API.
|
package basic implements a low-level client for the step-runner gRPC service with a (more or less) 1:1 mapping to the raw gRPC API. |
|
api/client/extended
package extended implements a well-behaved, higher-level client for the step-runner gRPC service.
|
package extended implements a well-behaved, higher-level client for the step-runner gRPC service. |
|
api/internal/jobs
package jobs implements
|
package jobs implements |
|
api/internal/streamer/file
package file implements the Streamer interface backed by a file buffer.
|
package file implements the Streamer interface backed by a file buffer. |
|
api/internal/variables
package variables implements a type and functions to handle CI job variables as described in https://docs.gitlab.com/ee/ci/variables.
|
package variables implements a type and functions to handle CI job variables as described in https://docs.gitlab.com/ee/ci/variables. |
|
api/service
package service implements the gRPC API declared in ../../../proto/step.proto
|
package service implements the gRPC API declared in ../../../proto/step.proto |
|
internal/syncmap
syncmap implements a simple generic, synchronized map.
|
syncmap implements a simple generic, synchronized map. |
|
schema
|
|