Skip to content

CreatingForwardingList.md

Latest commit

 

History

History
54 lines (38 loc) · 3.52 KB

CreatingForwardingList.md

File metadata and controls

54 lines (38 loc) · 3.52 KB

Creating the ForwardingList

This is the step by step cookbook for creating the ForwardingList.

Please read the following conceptual documents before working on the ForwardingList:

File Handling

  • Assure that there is a copy of the latest template of the ForwardingList in the develop branch of your application's repository. The latest ApplicationPattern+forwardings.yaml can be downloaded from the ApplicationPattern repository.
  • Rename the file, by replacing "ApplicationPattern" by your application's name.

Preparation

  • If not yet existing, create an Issue for elaborating the ForwardingList.
  • Open a local feature branch for elaborating the ForwardingList.

Individualization

Please, don't alter the existing entries in the ForwardingList, except for the following individualization.

  • Use CTRL+h for replacing 'xx-1-0-0' by the abbreviation of your application's name and release number 'ro-2-0-1'.

Apart from this, please focus on zones indicated by comments starting with '##'.
Add the descriptions of the Forwardings that are individual to your application into these sections.

The following proceeding is recommended:

  • Copy an empty description block and put a descriptive ForwardingName for every Forwarding you need.
  • After completing the list, double check the ordering of the blocks.
  • Add the ForwardingType at all blocks.
  • Add InitiatingRequests and ConsequentRequests (but without UUIDs) at all blocks.
  • Add the ManagementRequests at all blocks.
  • After double checking the result and particularly the ordering, add the UUIDs of the Forwardings.
  • If you are sure that the ServiceList is stable, add the UUIDs of the OperationsServers and OperationClients.

Validation and Finalization

  • Double check your ForwardingList.
  • Commit to your local feature branch.
  • Push your local feature branch to the remote repository.
  • Create a Pull-Request.
  • Please, regard the test results of the YAML linting in the Pull-Request. Correct the syntax of the ForwardingList, if errors are indicated (warnings need not to be regarded), and commit and push again until the ForwardingList in the remote repository is successfully validated.
  • Select a Reviewer from the team.
  • Assign the Pull-Request to yourself.