Add support for setting a force redirect status in Netlify _redirects file

[RobertWSaunders]

Proposed Change

Builds upon: #2890

When adding multiple domains in Netlify it can be nice to redirect domain aliases to your primary domain. In order to do so you need to add the correct redirect information into a _redirects file in the root of your site folder. The gatsby-netlify-plugin provides a nice way to automatically generate this file for us using the createRedirect action, see the documentation for it here. However, it does not allow us to set a redirect status with the force option which is mentioned in the Netlify redirect documentation here. In order for domain aliases redirects and any other redirect that wants to override existing content in the path to work correctly we need to add the ability to set a forced redirect status in our _redirects file. A forced status is denoted with an exclamation mark at the end of the status number. This change adds support for force: true to be passed into createRedirect which will result in a redirect status code with an exclamation mark concatenated to it in the outputted _redirects file.

For example:

createRedirect({ fromPath: "https://qhacks.ca/*", toPath: "https://qhacks.io/:splat", isPermanent: true, force: true });

Will output:

https://qhacks.ca/*  https://qhacks.io/:splat  301!

How did you do this?

Accept the force option to createRedirect and use it to build a redirect status.

Why are you choosing this approach?

Improves functionality of gatsby-netlify-plugin!

Any open questions you want to ask code reviewers?

Nope! 😎

List of changes:

• Update createRedirect redux action!
• Accept new force argument to createRedirect and build a redirect status from it.

[RobertWSaunders]

cc @bvaughn @KyleAMathews

[pieh]

I think this is fine, I just don't like adjusting gatsby API docs for netlify specific redirect flag - this probably belong to netlify plugin

[RobertWSaunders]

So @pieh instead of adding to Gatsby createRedirect action docs, document this in the gatsby-netlify-plugin? I can add the appropriate docs, would the README for the plugin be a good place?

[pieh]

Yeah, that would be great @RobertWSaunders!

[RobertWSaunders]

Updated!

[shannonbux]

Thanks for filling out the PR so completely @RobertWSaunders! @pieh I'll let you merge this one just in case there's any more technical feedback

[RobertWSaunders]

Any updates on this @pieh?

[pieh]

LGTM, thanks @RobertWSaunders and sorry for wait

[gatsbot]

Holy buckets, @RobertWSaunders — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. (Currently we’ve got a couple t-shirts available, plus some socks that are really razzing our berries right now.)
2. We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. You’ll receive an email shortly asking you to confirm. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

[RobertWSaunders]

Awesome, thanks @pieh!