Feature Request: Option to require changelog & tags #849

New Issue

OVERLORD · 2026-02-04T22:28:57+03:00

OVERLORD commented

2026-02-04 22:28:57 +03:00

Originally created by @TBK on GitHub (Oct 7, 2018).

Describe the feature you'd like
Option to force users to fill the changelog otherwise the save action can not be executed and the user will be prompted.

A likewise option and behaviour for tags.

Describe the benefits this feature would bring to BookStack users
Ensure the quality of the revision log.

Additional context
Changelog could be moved to the toolbox tab and also display the changelog history.

I have created a quick example of how it could look.

Originally created by @TBK on GitHub (Oct 7, 2018). **Describe the feature you'd like** Option to force users to fill the changelog otherwise the save action can not be executed and the user will be prompted. A likewise option and behaviour for tags. **Describe the benefits this feature would bring to BookStack users** Ensure the quality of the revision log. **Additional context** Changelog could be moved to the toolbox tab and also display the changelog history. I have created a quick example of how it could look. ![image](https://user-images.githubusercontent.com/858296/46576921-3fc7a400-c9d7-11e8-8043-95c74b64d2be.png)

OVERLORD added the 🔨 Feature Request :cat2:🐈 Possible duplicate labels 2026-02-04 22:28:57 +03:00

OVERLORD commented

2026-02-04 22:29:13 +03:00

@lithium-ap commented on GitHub (Oct 9, 2018):

Oh this would be great for the absent minded contributors!

@lithium-ap commented on GitHub (Oct 9, 2018): Oh this would be great for the absent minded contributors!

OVERLORD commented

2026-02-04 22:29:18 +03:00

@Abijeet commented on GitHub (Nov 25, 2018):

Somewhat similar to #941

@Abijeet commented on GitHub (Nov 25, 2018): Somewhat similar to #941

OVERLORD commented

2026-02-04 22:29:20 +03:00

@ssddanbrown commented on GitHub (Oct 23, 2025):

I put together a simple snippet, for requiring changelog, for a BookStack support customer, so thought I'd share the customization here too. Just needs to be added to the "Custom HTML Head Content" customization setting:

<script type="module" >
    /**
     * The error message to display when the changelog input is empty on form submit.
     */
    const validationErrorMessage = 'A changelog entry is required before saving page changes';

    // First, we get the changelog input and check if it's in the current view.
    /** @type {HTMLTextAreaElement | null} */
    const changelogInput = document.querySelector('form[action*="/page/"] textarea[name="summary"]');
    if (changelogInput) {
        // If so, we get the parent page edit form and listen to submit events.
        const form = changelogInput.closest('form');
        form.addEventListener('submit', function (event) {
            // If the input is empty, we prevent the form from submitting and show an error.
            if (changelogInput.value.trim() === '') {
                event.preventDefault();
                window.$events.error(validationErrorMessage);
            }
        });
    }
</script>

@ssddanbrown commented on GitHub (Oct 23, 2025): I put together a simple snippet, for requiring changelog, for a BookStack support customer, so thought I'd share the customization here too. Just needs to be added to the "Custom HTML Head Content" customization setting: ```html <script type="module" > /** * The error message to display when the changelog input is empty on form submit. */ const validationErrorMessage = 'A changelog entry is required before saving page changes'; // First, we get the changelog input and check if it's in the current view. /** @type {HTMLTextAreaElement | null} */ const changelogInput = document.querySelector('form[action*="/page/"] textarea[name="summary"]'); if (changelogInput) { // If so, we get the parent page edit form and listen to submit events. const form = changelogInput.closest('form'); form.addEventListener('submit', function (event) { // If the input is empty, we prevent the form from submitting and show an error. if (changelogInput.value.trim() === '') { event.preventDefault(); window.$events.error(validationErrorMessage); } }); } </script> ```

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#849