feat: add initial workflow status in config

[RomainOliva]

Summary

closes #1306

For our case we now use the editional workflow, we use it to preview our changes, but sometimes we just want to publish directly.
And this is not possible, we have to save, change status to ready and publish.

I would have preferred to do this issue #4054 but it seemed more complex for a first issue on the project :)

The goal here is to add the initial status in the configuration, then in our cas we can put PENDING_PUBLISH status by default and then publish directly.

Test plan

Checklist

Please add a x inside each checkbox:

• I have read the contribution guidelines.
• Code is formatted via running yarn format.
• Tests are passing via running yarn test.
• The status checks are successful (continuous integration). Those can be seen below.

[RomainOliva]

I don't really know where to add the expected test, if you can guide me :)

[bytrangle]

This should have gone to a different PR but I'm going to accept it since its scope is small.

[bytrangle]

Very neat editing.

As for testing, I haven't tried it out but it might be about checking if the unpublished entry object has the default_workflow_status property with the value that a user sets in the config.

I think it could go something like this:

• create a placeholder config object which contains the default_workflow_status property
• create a new backend instance, each for all the supported backends.
• create a state object which contains the config object: state = { config, ... }
• call the unpublishedEntry method of the Backend class, passing to it the state object.
• check if the result contains a default_workflow_status property whose value is whatever set in the config object

What do you think?

[RomainOliva]

Hello @bytrangle, thanks for your review.

I tried when I start the backend, and everything work right.
But inside test I can't find where I can test this behavior, in the file that you have pointed out to me it doesn't work because it's looks like it's not in "editorial_workflow".

I tried here :

• https://github.com/netlify/netlify-cms/blob/dbf2920254fb3682e12463a6df8ded4b94b55be0/packages/netlify-cms-core/src/__tests__/backend.spec.js#L347

And here :

• https://github.com/netlify/netlify-cms/blob/cb2ad687ee250937a9dffc21ebfd4c399c6d76db/packages/netlify-cms-backend-test/src/__tests__/implementation.spec.js#L48
  But we can only access to the window.repoFiles where there is no the entry workflow state.

Can you give me a little help please?

[bytrangle]

On further investigation, I think the test should be in netlify-cms-core/.../actions/__tests__/config.spec.js.

I got the idea from the test "should set publish_mode from config". I've tried create a barebone config object with two props: publish_mode and default_workflow_status.

Then I called applyDefaults(config). This function takes the original config object parsed from config.yml file and mutate it so that certain important properties won't be undefined if the user forgot to add them.

For example, publish_mode has to be SIMPLE_WOKFLOW, slug has to be an empty object, collections is an empty array unless specified otherwise in the config.

Then I check if applyDefaults(config).default_workflow_status is equal to the value I passed to the namesake property of the config.

You'll also need to modify the applyDefaults(config) so that if the user sets publish_mode to editorial_workflow, and don't specify the default_workflow_status, the mutated config will have a property default_workflow_status set to draft.

Does that make sense?

[RomainOliva]

@bytrangle Oh nice ! It's really clear, I will do that :)

Just for your last sentence, you really think it's useful with the following code ?

• https://github.com/RomainOliva/netlify-cms/blob/e89358a11101377de3c0ca3eb7187a3cf8b545e1/packages/netlify-cms-core/src/reducers/config.ts#L38

With this line if there is no default_workflow_status it take the first status (draft one)

thanks again for your help

[RomainOliva]

@bytrangle I just add a fixup commit with some change and the test, tell me if this sounds good to you :)

[bytrangle]

@krider2010 Look forward to your review.

[krider2010]

Just a heads up I'm working on being added to the maintainer group for review reasons.

[RomainOliva]

@bytrangle There is no other reviewer who can watch this pr? :)

[RomainOliva]

@bytrangle Small up please, this feature would allow us to save a lot of time in our processes 🙈

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[RomainOliva]

It is still relevant today 🙈

[emp3ror]

It is still relevant today see_no_evil

waiting for this to happen

[martinjagodic]

@RomainOliva are you still interested in moving this forward?

[RomainOliva]

@martinjagodic Yes, it can be interesting to merge it 😇

[martinjagodic]

Great! Can you solve the merge conflicts? They mostly emerged because of the package rename.

[netlify]

‼️ Deploy request for cms-demo rejected.

Name	Link
🔨 Latest commit	cb2ee3d

[netlify]

✅ Deploy Preview for decap-www ready!

Name	Link
🔨 Latest commit	cb2ee3d
🔍 Latest deploy log	https://app.netlify.com/sites/decap-www/deploys/654e52adad3a9d00086355ce
😎 Deploy Preview	https://deploy-preview-6469--decap-www.netlify.app/docs/configuration-options
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[RomainOliva]

@martinjagodic sorry for the delay, it's all good the PR is rebased :)