{
    "componentChunkName": "component---src-templates-plugin-docs-tsx",
    "path": "/plugins/scm-openproject-plugin/docs/1.0.x/en/configuration/",
    "result": {"data":{"plugin":{"name":"scm-openproject-plugin","displayName":"OpenProject","description":"OpenProject integration","author":"Cloudogu GmbH","documentation":[{"version":"1.0.x","languages":["de","en"]}]},"navigation":{"nodes":[{"section":"First steps","entries":[{"frontmatter":{"title":"Configuration","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-openproject-plugin/docs/1.0.x/en/configuration/"}},{"frontmatter":{"title":"Permissions","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-openproject-plugin/docs/1.0.x/en/permissions/"}},{"frontmatter":{"title":"Commit Message Validator","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-openproject-plugin/docs/1.0.x/en/commitmessagechecker/"}},{"frontmatter":{"title":"Pull Requests","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-openproject-plugin/docs/1.0.x/en/pullrequests/"}}]}]},"versions":{"group":[{"fieldValue":"1.0.x"}]},"languages":{"group":[{"fieldValue":"de"},{"fieldValue":"en"}]},"markdownRemark":{"html":"<p>The SCM-OpenProject-Plugin can be configured globally and repository specific. The global configuration is used for all\nrepositories that don't have a specific config. The repository specific configuration can be disabled in the global config.</p>\n<h3 id=\"configuration-form\" style=\"position:relative;\"><a href=\"#configuration-form\" aria-label=\"configuration form permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Configuration form</h3>\n<p>To connect SCM-Manager with OpenProject, an instance URL including the context path is required.\nAfterwards, you can already configure how the OpenProject issues are modified or updated.</p>\n<h4 id=\"create-comments\" style=\"position:relative;\"><a href=\"#create-comments\" aria-label=\"create comments permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Create comments</h4>\n<p>To create comments in OpenProject, credentials are mandatory. They should belong to a technical OpenProject user.\nThis user also needs sufficient permissions to add comments to existing issues (\"View issues\" &#x26; \"Add notes\").\nFurthermore, the REST interface of OpenProject must be activated. The setting is located in OpenProject under\n<code class=\"language-text\">Administration → API and webhooks → API → Enable REST web service</code>.</p>\n<p>Comments are generated on the OpenProject issue if the issue id is mentioned within a commit message.</p>\n<p>Example commit message: \"#492 Add awesome new feature\".</p>\n<p>This will create a comment with this commit message on OpenProject issue 492.</p>\n<h4 id=\"update-issue-status\" style=\"position:relative;\"><a href=\"#update-issue-status\" aria-label=\"update issue status permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a>Update issue status</h4>\n<p>To change the status of an issue via a commit message, an issue id and a OpenProject status must be in one sentence.</p>\n<p>Example commit message: \"Bug #42 closed\".</p>\n<p>The example sets the status of issue 42 to \"Closed\".\nOf course, this assumes that the status \"Closed\" exists in the specified OpenProject instance.</p>\n<blockquote>\n<p><strong>Important:</strong> The configured openproject user needs permissions to change the status of issues (\"Edit issues\").</p>\n<p>Furthermore, please avoid to use more than one mapped keyword in one comment as this can cause undesired side effects.</p>\n</blockquote>\n<p>Using the \"OpenProject status mapping\", you can define keywords that can be used instead of the OpenProject status.\nThese keywords can be specified in the form of a comma-separated list.\nFor example, for the status \"Closed\" you could specify the following keywords: \"closes, closing\".\nThe commit message \"Closes Bug #42\" would then also set the ticket 42 to the status \"Closed\".</p>\n<p>If the status should only be updated due to pull requests and not by commits, the additional option \"Disable issue\nstate changes by commits\" can be selected.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 590px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 73.64864864864865%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAPCAYAAADkmO9VAAAACXBIWXMAAAsTAAALEwEAmpwYAAABmElEQVQ4y41U2U7DMBD0b4OExN/xgsQrzxAJ1ITajc/1NWidowctjaVRovVmvDO7jvjsOnRdh363Q1u1Yssqc967JDy+fOP5dcDDq4SQ4whtHbQxsM6jVCDXehecRznCOIu9lAgUkSsgQqoIIcAziObk7eBvpdzDOYdaCsSPMrDWgogQiFYpd9ecF2OEUgrGGNRaIbTRCCnPvmyTe5RdEXLFYAmpTAcIQwVEAT4m1PXw7ZI5t+97SCmRc4awnmCtgfMekQhE8Sh7/gC4ZsMUY98WsibZe9f0a61hnQPFhbBeWFb/YIlzD5iwSWaiYRigtEG5KIQNH8cRIab/uoOd0lDWT4TqcIBxHpQyUi6IMSGlCd4H7NUBjiIi76XjHo8LgyvkgznWCHkoR2MbGaXUPOQR4iT2VapDi8eUz/ZYpvd+lb7IFyHQ6ltDKc0PBlfEs5k5dhLnHB5kBr+feio4sMhIc+lbRttZi1Gp1uWlukbYpDnXyp8Qpi5f6epaCT+5aZguwhnhrWt1i2yZ0Q9KePra482Fs7/PL5iFmygpv/1rAAAAAElFTkSuQmCC'); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"OpenProject configuration\"\n        title=\"OpenProject configuration\"\n        src=\"/static/3406948fa2a0d1f40bbdb0a474335050/fcda8/config.png\"\n        srcset=\"/static/3406948fa2a0d1f40bbdb0a474335050/12f09/config.png 148w,\n/static/3406948fa2a0d1f40bbdb0a474335050/e4a3f/config.png 295w,\n/static/3406948fa2a0d1f40bbdb0a474335050/fcda8/config.png 590w,\n/static/3406948fa2a0d1f40bbdb0a474335050/efc66/config.png 885w,\n/static/3406948fa2a0d1f40bbdb0a474335050/c83ae/config.png 1180w,\n/static/3406948fa2a0d1f40bbdb0a474335050/4352a/config.png 1364w\"\n        sizes=\"(max-width: 590px) 100vw, 590px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n        decoding=\"async\"\n      />\n    </span></p>","description":"The SCM-OpenProject-Plugin can be configured globally and repository specific. The global configuration is used for all\nrepositories that don't have a specific…","tableOfContents":"<ul>\n<li>\n<p><a href=\"#configuration-form\">Configuration form</a></p>\n<ul>\n<li><a href=\"#create-comments\">Create comments</a></li>\n<li><a href=\"#update-issue-status\">Update issue status</a></li>\n</ul>\n</li>\n</ul>","frontmatter":{"title":"Configuration","subtitle":null,"description":null,"keywords":null,"displayToc":null,"image":null}}},"pageContext":{"name":"scm-openproject-plugin","slug":"/plugins/scm-openproject-plugin/docs/1.0.x/en/configuration/","version":"1.0.x","latestVersion":"1.0.x","latestPageVersion":"1.0.x","language":"en","canonicalPath":"/plugins/scm-openproject-plugin/docs/latest/en/configuration/","latestRootPath":"/plugins/scm-openproject-plugin/docs/1.0.x/en/"}},
    "staticQueryHashes": ["1973669194","2742214048","2956773653","2957019495","698804963"]}