Sharing code across workflows

Actions are reusable steps. When you author an action, you can add it to your workflow like you would other actions, by clicking the + button below any step.

Pipedream provides two ways to share code across workflows:

• Publish an action from a Node.js code step. Publish any Node.js code step as a reusable action from the Pipedream dashboard.

• Create an action from code. Develop your action code on your local filesystem and publish to your Pipedream account using the Pipedream CLI.

Publish an action from a Node.js code step

You can publish any of your Node.js code steps into a reusable action. This enables you to write a Node.js code step once, and reuse it across many workflows without rewriting it.

To convert a Node.js code step into an publishable action, make sure to include the below properties in your Node.js step:

• version
• name
• key
• type

// Adding properties to a regular Node.js code step make it publishable
import { parseISO, format } from 'date-fns';
 
// Returns a formatted datetime string
export default defineComponent({
  name: 'Format Date',
  version: '0.0.1',
  key: 'format-date',
  type: 'action',
  props: {
    date: {
      type: "string",
      label: "Date",
      description: "Date to be formatted",
    },
    format: {
      type: 'string',
      label: "Format",
      description: "Format to apply to the date. [See date-fns format](https://date-fns.org/v2.29.3/docs/format) as a reference."
    }
  },
  async run({ $ }) {
    const formatted = format(parseISO(this.date), this.format);
    return formatted;
  },
})
 

Click Test to verify the step is working as expected. Only actions that have been successfully tested are to be published.

Then open the menu in the top righthand corner of the code step and select Publish to My Actions:

And now you've successfully saved a custom Node.js code step to your account. You'll be able to use this code step in any of your workflows.

Using your published actions

To use your custom action, create a new step in your workflow and select My Actions.

From there you'll be able to view and select any of your published actions and use them as steps.

Updating published Node.js code step actions

If you need to make a change and update the underlying code to your published Node.js code step, you can do so by incrementing the version field on the Node.js code step.

Every instance of your published action from a code step is editable. In any workflow where you've reused a published action, open the menu on the right side of the action and click Edit action button.

This will open up the code editor for this action, even if this wasn't the original code step.

Now increment the version field in the code:

import { parseISO, format } from 'date-fns';
 
// The version field on a Node.js action is versioned
export default defineComponent({
  name: 'Format Date',
  version: '0.0.2',
  key: 'format-date',
  type: 'action',
  props: {
    date: {
      type: "string",
      label: "Date",
      description: "Date to be formatted",
    },
    format: {
      type: 'string',
      label: "Format",
      description: "Format to apply to the date. [See date-fns format](https://date-fns.org/v2.29.3/docs/format) as a reference."
    }
  },
  async run({ $ }) {
    const formatted = format(parseISO(this.date), this.format);
    return formatted;
  },
})

Finally use the Publish to My Actions button in the right hand side menu to publish this new version.

After publishing a new version, all other steps using this same action will have the option to update to the latest version.

Differences between publishing actions from workflow Node.js code steps and directly from code

Publishing reusable actions from Node.js code steps allows you to quickly scaffold and publish Node.js code steps without leaving the Pipedream dashboard. The result is the same as publishing actions from code using the Pipedream CLI.

However, there are some differences.

1. Node.js code step actions cannot make use of app files to further reduce redundancy.
2. Node.js code step actions cannot be published to the Pipedream Component Registry.
3. Node.js code step actions have a slightly different structure than action components.