Uploaded image for project: 'Bitbucket Data Center'
  1. Bitbucket Data Center
  2. BSERV-9521

Allow plugins to perform commit message and file content checks when editing a file in the browser

    • We collect Bitbucket feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      The 'File Edit' feature was introduced in 4.13.0 and allows plugins to prevent a file edit from being committed by raising the cancelable FileEditRequestedEvent.

      The event in it's current form provides the repository, branch and the affected path, which is fine for permission-based checks. It does not however include the commit message or the new file content, which makes the event insufficient for plugin-proved checks that enforce commit message standards, or do content checks.

      Adding the following fields to the event would make the event more useful:

      • commit message
      • updated file content

      Workaround

       The File Edit feature can be globally disabled by adding the following setting to BITBUCKET_HOME/shared/bitbucket.properties and restarting:

      feature.in.browser.editing=false
      feature.file.editor=false

            [BSERV-9521] Allow plugins to perform commit message and file content checks when editing a file in the browser

            Katherine Yabut made changes -
            Workflow Original: JAC Suggestion Workflow [ 3394438 ] New: JAC Suggestion Workflow 3 [ 3616624 ]
            Status Original: RESOLVED [ 5 ] New: Closed [ 6 ]
            Monique Khairuliana (Inactive) made changes -
            Workflow Original: BSERV Suggestions Workflow [ 2685982 ] New: JAC Suggestion Workflow [ 3394438 ]
            Owen made changes -
            Workflow Original: Stash Workflow [ 1652700 ] New: BSERV Suggestions Workflow [ 2685982 ]
            Status Original: Closed [ 6 ] New: Resolved [ 5 ]
            Michael Heemskerk (Inactive) made changes -
            Description Original: The 'File Edit' feature was introduced in 4.13.0 and allows plugins to prevent a file edit from being committed by raising the cancelable {{FileEditRequestedEvent}}.

            The event in it's current form provides the repository, branch and the affected path, which is fine for permission-based checks. It does not however include the commit message or the new file content, which makes the event insufficient for plugin-proved checks that enforce commit message standards, or do content checks.

            Adding the following fields to the event would make the event more useful:
             * commit message
             * updated file content

            h4. Workaround

             
            New: The 'File Edit' feature was introduced in 4.13.0 and allows plugins to prevent a file edit from being committed by raising the cancelable {{FileEditRequestedEvent}}.

            The event in it's current form provides the repository, branch and the affected path, which is fine for permission-based checks. It does not however include the commit message or the new file content, which makes the event insufficient for plugin-proved checks that enforce commit message standards, or do content checks.

            Adding the following fields to the event would make the event more useful:
             * commit message
             * updated file content

            h4. Workaround

             The File Edit feature can be globally disabled by adding the following setting to {{BITBUCKET_HOME/shared/bitbucket.properties}} and restarting:
            {noformat}
            feature.in.browser.editing=false
            feature.file.editor=false{noformat}
            Michael Heemskerk (Inactive) made changes -
            Description Original: The 'File Edit' feature was introduced in 4.13.0 and allows plugins to prevent a file edit from being committed by raising the cancelable {{FileEditRequestedEvent}}.

            The event in it's current form provides the repository, branch and the affected path, which is fine for permission-based checks. It does not however include the commit message or the new file content, which makes the event insufficient for plugin-proved checks that enforce commit message standards, or do content checks.

            Adding the following fields to the event would make the event more useful:
             * commit message
             * updated file content
            New: The 'File Edit' feature was introduced in 4.13.0 and allows plugins to prevent a file edit from being committed by raising the cancelable {{FileEditRequestedEvent}}.

            The event in it's current form provides the repository, branch and the affected path, which is fine for permission-based checks. It does not however include the commit message or the new file content, which makes the event insufficient for plugin-proved checks that enforce commit message standards, or do content checks.

            Adding the following fields to the event would make the event more useful:
             * commit message
             * updated file content

            h4. Workaround

             
            Michael Heemskerk (Inactive) made changes -
            Fix Version/s New: 5.0.0 [ 66696 ]
            Resolution New: Fixed [ 1 ]
            Status Original: In Progress [ 3 ] New: Closed [ 6 ]
            Michael Heemskerk (Inactive) made changes -
            Status Original: Open [ 1 ] New: In Progress [ 3 ]
            Michael Heemskerk (Inactive) made changes -
            Link New: This issue is incorporated by BSERVDEV-14833 [ BSERVDEV-14833 ]
            Michael Heemskerk (Inactive) made changes -
            Assignee New: Michael Heemskerk [ mheemskerk ]
            Roger Barnes (Inactive) made changes -
            Status Original: Needs Triage [ 10030 ] New: Open [ 1 ]

              mheemskerk Michael Heemskerk (Inactive)
              mheemskerk Michael Heemskerk (Inactive)
              Votes:
              12 Vote for this issue
              Watchers:
              19 Start watching this issue

                Created:
                Updated:
                Resolved: