To create an action that is run after a build has completed you need to implement the IPostGenerationAction interface.
If your action requires user input for you can decorate your class with multiple [XStaticEditableField("YourFieldName")] attributes and these will be shown as text boxes in the Umbraco interface.
These are then passed in as a dictionary to your RunAction method.
All created post generations are automatically found by xStatic so you don't need to do any further configuration.
However, if you have a custom constructor for your action then you need to register the class on startup.
E.g. services.AddTransient<Netlify404Action>();
With this class created you can now create an action within Umbraco.
Go to the Actions dashboard, create a new action, fill in the fields and save.
You can now add this action to your static site definitions.
[XStaticEditableField("FilePath")]
public class FileDeleteAction : IPostGenerationAction
{
private readonly IStaticSiteStorer _staticSiteStorer;
public virtual string Name => nameof(FileDeleteAction);
public FileDeleteAction(IStaticSiteStorer staticSiteStorer)
{
_staticSiteStorer = staticSiteStorer;
}
public virtual async Task<XStaticResult> RunAction(int staticSiteId, Dictionary<string, string> parameters)
{
var existingFilePath = parameters["FilePath"];
return await DeleteFile(staticSiteId, existingFilePath);
}
protected virtual async Task<XStaticResult> DeleteFile(int staticSiteId, string existingFilePath)
{
var absoluteFilePath = FileHelpers.PathCombine(_staticSiteStorer.GetStorageLocationOfSite(staticSiteId), existingFilePath);
try
{
await _staticSiteStorer.DeleteFile(absoluteFilePath);
}
catch (Exception e)
{
return XStaticResult.Error("Error running file delete action", e);
}
return XStaticResult.Success();
}
}
