feat(#203): RunException access modifier set to public. Docs updated

[mmisztal1980]

As per discussion in #203 . This is a simple improvement in order to make the exception assertable by testing frameworks such as FluentAssertions using:

var action = () => 
{
  // (...) // provision failing pulumi resources here
};

action.Should().Throw<Pulumi.RunException>();

This will significantly improve testing scenarios where exceptions are being thrown, as everything gets wrapped in an internal Pulumi.RunException while testing:

// Disassembled code
internal static async Task<(ImmutableArray<Resource> Resources, Exception? Exception)> TryTestAsync(
            IMocks mocks, Func<IRunner, Task<int>> runAsync, TestOptions? options = null)
        {
            var engine = new MockEngine();
            var monitor = new MockMonitor(mocks);
            await CreateRunnerAndRunAsync(() => new Deployment(engine, monitor, options), runAsync).ConfigureAwait(false);
            Exception? err = engine.Errors.Count switch
            {
                1 => new RunException(engine.Errors.Single()), // <-- wrapping takes place here
                var v when v > 1 => new AggregateException(engine.Errors.Select(e => new RunException(e))),
                _ => null
            };
            return (Resources: monitor.Resources.ToImmutableArray(), Exception: err);
        }

[tgummerer]

Thanks for the PR. I'll let someone with more context approve and merge this, but do have a small suggestion for a changelog improvement (see also https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md#changelog-messages for how we write our changelog messages)

[mmisztal1980]

@tgummerer when do You think someone will get the chance to look at this? :)

[Zaid-Ajaj]

Hi there @mmisztal1980 thanks a lot for the contribution 🙏 we discussed this with the team and we thought it made sense to make the exception public.

[mmisztal1980]

@Zaid-Ajaj awesome!
When is the next package release due to happen?

[Zaid-Ajaj]

When is the next package release due to happen?

@mmisztal1980 Not planned at the moment, but we publish dev sdks from commits merged into main so you will be able to use the an alpha package containing your changes

[pulumi-bot]

This PR has been shipped in release v3.69.0.