Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add title, summary and description to the pipeline model #876

Merged
merged 2 commits into from
Jul 4, 2023
Merged

feat: add title, summary and description to the pipeline model #876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33d883a
feat: add title, summary and description to the pipeline model
morbalint Jun 28, 2023
bc594b2
address code review comments
morbalint Jul 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _lessons/lesson1_steps/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ First of all let's talk about Steps. Steps are the building blocks of a [Bitrise
Now that you created your first local project (by calling the `bitrise setup` and after it the `bitrise init`) we can have some fun with the Steps! Open the bitrise.yml and let's add some steps!

## StepID
SetpID is a unique identifier of a step. In your Workflow you have to include this ID to tell [Bitrise](https://bitrise.io) which Step you'd like to run. In our [StepLib](https://github.com/bitrise-io/bitrise-steplib) if you open the [steps folder](https://github.com/bitrise-io/bitrise-steplib/tree/master/steps) you can see that every Step folder's name is the StepID.
StepID is a unique identifier of a step. In your Workflow you have to include this ID to tell [Bitrise](https://bitrise.io) which Step you'd like to run. In our [StepLib](https://github.com/bitrise-io/bitrise-steplib) if you open the [steps folder](https://github.com/bitrise-io/bitrise-steplib/tree/master/steps) you can see that every Step folder's name is the StepID.

### StepID format in the .yml

Expand Down
8 changes: 7 additions & 1 deletion models/models.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,20 @@ type StepListItemModel map[string]stepmanModels.StepModel

// PipelineModel ...
type PipelineModel struct {
Stages []StageListItemModel `json:"stages,omitempty" yaml:"stages,omitempty"`
Title string `json:"title,omitempty" yaml:"title,omitempty"`
godrei marked this conversation as resolved.
Show resolved Hide resolved
Summary string `json:"summary,omitempty" yaml:"summary,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Stages []StageListItemModel `json:"stages,omitempty" yaml:"stages,omitempty"`
}

// StageListItemModel ...
type StageListItemModel map[string]StageModel

// StageModel ...
type StageModel struct {
Title string `json:"title,omitempty" yaml:"title,omitempty"`
Summary string `json:"summary,omitempty" yaml:"summary,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
ShouldAlwaysRun bool `json:"should_always_run,omitempty" yaml:"should_always_run,omitempty"`
AbortOnFail bool `json:"abort_on_fail,omitempty" yaml:"abort_on_fail,omitempty"`
RunIf string `json:"run_if,omitempty" yaml:"run_if,omitempty"`
Expand Down