serverless-operations / serverless-operations/serverless-step-functions

Support to separate step functions states into different yml files

Open
#538 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area: state-machine enhancement
Dominant language
JavaScript
Stars
1k
Forks
220
PR merge metrics
No merged PRs in 30d

Description

This is a Feature Proposal

Description

For feature proposals:

  • It is currently possible to create a separate state machine (#177) within a different file; however, it would be nice to also allow the possibility to split states into their own files as well, so that users do not have to re-define the same functionality multiple times. It does not seem like the plugin supports a similar approach at the state level, though.

I believe the definition may look something like this:

stepFunctions:
  stateMachines:
    mundaneTask:
      name: '${self:provider.stage}-something-repetitive  
      definition:
        Comment: 'Starts a file upload'
        StartAt: repetitiveStep
        States:
          repetitiveStep: ${file(something-repetitive.yml)}

Any feedback or help would be appreciated!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source files, tests, or entry points are named in the proposal. Start by tracing how the plugin currently loads state machine definitions and handles ${file(...)} references, then determine the expected behavior for state-level files from the YAML example. Done should include documented support for separate state definitions and coverage for the resulting configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, javascript
Domain
cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.