Skip to content

Proposal: Cloudant nodes #1

Open

Description

@knolleary

The original cloudant node is node-red-node-cf-cloudant by @lgfa29. This is the node included in the Node-RED Starter App on IBM Cloud.

There have been a number of forks of the node, most notably node-red-contrib-cloudantplus maintained by @hammoaj

The cloudantplus node is actively maintained and has added a number of features over the original node. It has been (rightly) published with a different set of node types so it doesn't cause clashes if a user installs both nodes.

I have permission from @lgfa29 to take ownership of the npm module of the original node so we can publish updates to it.

I also have the support of @hammoaj who will be joining this community.

The tentative plan is:

  1. fork node-red-node-cf-cloudant into this organisation
  2. merge the changes from cloudantplus into that repository
  3. update the node types back to the original ones
  4. publish a new version of the original node to npm.
  5. update (with help from @lgfa29) the original cf-cloudant repository readme to mark it as deprecated and point to the repo in this organisation
  6. update (with help from @hammoaj) the original cloudantplus repository to mark it as deprecated and point to the repo in this organisation

We may want to have a small period where updates are made to both the cf-cloudant repo and the original cloudantplus repo. This will allow updates to be made to both npm modules (with their different node types), to give users time to migrate back to cf-cloudant module.

That gets us to a clean baseline for the future development of the node.

Activity

  1. Stwissel commented on Jun 19, 2021

    @Stwissel
  2. hammoaj commented on Jun 20, 2021

    @hammoaj
  3. Stwissel commented on Jun 21, 2021

    @Stwissel

    ;-) We all agree we need to do an "Highlander" to all the forks out there.
    As long as it is current, I'm good with any name/location for the Nodes

  4. johnwalicki commented on Jun 22, 2021

    @johnwalicki
    Member

    One path forward would be to rebase node-red-node-cf-cloudant on node-red-contrib-cloudantplus and adopt it as the forward code base. With that migration, upstream would move here, get a millions? of downstream apps to upgrade. Gives us a supported (@hammoaj and others) solution.

  5. johnwalicki commented on Jun 22, 2021

    @johnwalicki
    Member
  6. knolleary commented on Jun 23, 2021

    @knolleary
    MemberAuthor

    @johnwalicki that's exactly what the plan has always been. We have done the rebase and merged here: node-red-contrib-ibm-cloud/node-red-node-cf-cloudant#1

    The missing step is getting that published to npm.

    If we can dbl check the code in that repo looks good, we can get it it published.

  7. hammoaj commented on Jun 23, 2021

    @hammoaj
  8. knolleary commented on Jun 23, 2021

    @knolleary
    MemberAuthor

    Happy to take your guidance on what the next steps are. I don't have access to cloudant these days to test the node myself.

    If you think the updates from Stephen are needed, then lets get them PR'd into the repo.

  9. hammoaj commented on Mar 24, 2022

    @hammoaj

    The latest cloudantplus code has now been published to npm. So I think that we are now ready to rebase the original node on the cloudantplus code. What is the best way of deprecating a node on Node-RED? I was thinking that once the original node is rebased and published, I would update the README to suggest people switch to the core node, but wasn't sure of whether there was a way of "redirecting" one node to use another more permanently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions