Document! X & HelpStudio Bundle 2022.1
Configure Build Profile and Build Flags / Build Configurations / Build Configuration Event Actions
In This Topic
    Build Configuration Event Actions
    In This Topic

    Build Configurations allow you to define a specific set of Build Profiles, Additional Locales, and Publishing Targets so that you can quickly Build and Publish a set of outputs as a single operation.

    Build Configurations can have one or more Event Actions that are executed each time the Build Configuration is Built. Event Actions can invoke an external program or script, or show / log a message. You might define an Event Action to invoke some external process that must be run each time you rebuild the documentation, or show a message during the Build process to remind/warn the user performing the build that some related manual process must take place.

    Event Actions execute when building interactively as well as when you build using Command Line.

    Event Action Fundamentals

    Create a new Event Action

    1. Click the Project Settings button on the Project ribbon tab.
    2. Select the Build Configurations page.
    3. Select the Build Configuration you want to add an Event Action to.
    4. Under the Custom Event Actions, click the Add New Event Action dropdown button.
    5. Choose the Event Type (Build or Publishing). Publishing events are useful if you are using Publishing features and you want an action to execute only after Publishing has completed.
    6. The new Event Action is created and added to the list.
    7. Use the provided dropdown lists to select the Event Action Sequence (Before or After Build/Publishing) and the Action Kind (Run a Program / Script or Show a Message).
    You can give the Event Action an identifying name (using the editable field directly next to the  Delete button) in order to identify it in the Build log.

     

    Delete an Event Action

    1. Click the Project Settings button on the Project ribbon tab.
    2. Select the Build Configurations page.
    3. Select the Build Configuration you want to add an Event Action to.
    4. Click the Delete toolbar button at the top-right of the Event Action in order to delete it.

     

    See Also