📝Create Forms

Before setting up the first Form

Your custom forms for the Pipline Forms app are stored in your repository, under the file named pipeline-forms.yml - which you have to create. pipeline-forms.yml should be on the root level, just next to thebitbucket-pipelines.ymlfile. New to Bitbucket Pipelines? Get started here!

The user created pipeline-forms.yml

This means that the file (all your forms) is version controlled by you, and any changes on the branches should be merged back to the main/master branch to be availabe - just as it works in bitbicket-pipelines.yml.

This also means that thepipeline-forms.yml file may vary branch-by-branch, which could lead to different options in your forms on different branches.

After creating a pipeline-forms.yml you can edit it with your expected forms then commit to make it visible on the UI.

Creating a form

Prerequisite: Make sure you have a pipeline in the bitbucket-pipelines.ymlwhich contains a custom pipeline, called "Demonstration pipeline". Otherwise you have to change that value in the upcoming example for an existing pipeline to select.

The pipeline-forms.yml can consist of the following configuration elements:

• groups - ability to group forms into presets

• fields - different type of input fields, may contain options

• forms - can be displyed to gather input data

  • linked to a pipeline

  • fields can be added on the forms

To show a form on the UI, you should add at least one valid form with a field on it.

Edit your pipeline-forms.yml with

• 1 group

• 2 simple fields

• a form (using the 2 fields)

• link the form with the "test" pipeline

• link the form with the group

pipeline-forms.yml

groups:
  - label: Important Forms
    key: IMFO
fields:
  - &test-text-field  
    label: Text field
    type: text
    name: TEST_TEXT_FIELD
    note: This will appear as a description under the field
    defaultValue: I am a test
    mandatory: true
  - &test-select-field
    label: Select field
    type: select
    name: TEST_SELECT_FIELD
    defaultValue: One
    availableValues:
      - One
      - Two
      - Three
forms:
  - name: Test Jira form
    fields:
      - *test-text-field
      - *test-select-field
    pipeline: Demonstration pipeline
    groups:
      - IMFO

PFO is currently parsing custom pipelines only, so make sure that you are using a custom pipeline.

The form will appear on the Pipeline Forms menu, when the proper branch and commit is selected.

New form is ready to use - when the proper commit is selected

To implement advanced forms, check out the Syntax for the pipeline-forms.yml file page!

Editing forms

Forms should be edited by editing the pipeline-forms.yml which is a user craeted file in your repository's root.

You can use your favourite source code editor, or simply use the Bitbucket UI code editor.

Adding a new form

When you have a form, just repeat the process and add another form in the same and only pipeline-forms.yml.

Validating forms

If you are unsure if your form has a valid syntax use the Validate option on the right top by copy-pasting your form's content in the editor:

Validating forms directly on the UI