| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>Merging a Pull Request :: causeway</title> |
| <link rel="canonical" href="https://causeway.apache.org/comguide/latest/merging-a-pull-request.html"> |
| <meta name="generator" content="Antora 3.1.14"> |
| <link rel="stylesheet" href="../../_/css/site.css"> |
| <link rel="stylesheet" href="../../_/css/site-custom.css"> |
| <link rel="home" href="https://causeway.apache.org" title="causeway"> |
| <link rel="next" href="applying-patches.html" title="Applying Patches"> |
| <link rel="prev" href="about.html" title="Committers' Guide"> |
| </head> |
| <body class="article"> |
| <header class="header"> |
| <nav class="navbar"> |
| <div class="navbar-brand"> |
| <a class="navbar-item" href="https://causeway.apache.org"> |
| <span class="icon"> |
| <img src="../../_/img/causeway-logo-no-words-65x48.png"></img> |
| </span> |
| <span class="navbar-title">causeway</span> |
| </a> |
| <button class="navbar-burger" data-target="topbar-nav"> |
| <span></span> |
| <span></span> |
| <span></span> |
| </button> |
| </div> |
| <div id="topbar-nav" class="navbar-menu"> |
| <a class="navbar-end"> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Quick Start</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Starter Apps</span> |
| <a class="navbar-item" href="../../docs/latest/starters/helloworld.html">Hello World</a> |
| <a class="navbar-item" href="../../docs/latest/starters/simpleapp.html">Simple App</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Learning & Tutorials</span> |
| <a class="navbar-item" href="../../docs/latest/reference/about.html">Reference App</a> |
| <a class="navbar-item" href="https://danhaywood.gitlab.io/isis-petclinic-tutorial-docs/petclinic/1.16.2/intro.html">Petclinic</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Resources</span> |
| <a class="navbar-item" href="../../docs/latest/resources/cheatsheet.html">Cheatsheet</a> |
| <a class="navbar-item" href="../../docs/latest/resources/icons.html">Icons</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Guides</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Core</span> |
| <a class="navbar-item" href="../../userguide/latest/about.html">User Guide</a> |
| <a class="navbar-item" href="../../refguide/latest/about.html">Reference Guide</a> |
| <a class="navbar-item" href="../../testing/latest/about.html">Testing Guide</a> |
| <a class="navbar-item" href="../../security/latest/about.html">Security Guide</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">For use in apps</span> |
| <a class="navbar-item" href="../../valuetypes/latest/about.html">Value Types</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Development</span> |
| <a class="navbar-item" href="../../setupguide/latest/about.html">Setup Guide</a> |
| <a class="navbar-item" href="../../conguide/latest/about.html">Contributors' Guide</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Components</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Security</span> |
| <a class="navbar-item" href="../../security/latest/bypass/about.html">Bypass</a> |
| <a class="navbar-item" href="../../security/latest/simple/about.html">Simple</a> |
| <a class="navbar-item" href="../../security/latest/spring/about.html">Spring</a> |
| <a class="navbar-item" href="../../security/latest/keycloak/about.html">Keycloak</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Viewers</span> |
| <a class="navbar-item" href="../../vw/latest/about.html">Web UI (Wicket)</a> |
| <a class="navbar-item" href="../../gqlv/latest/about.html">GraphQL API</a> |
| <a class="navbar-item" href="../../vro/latest/about.html">REST API (Restful Objects)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Persistence</span> |
| <a class="navbar-item" href="../../pjpa/latest/about.html">JPA (EclipseLink)</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Extensions</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Core</span> |
| <a class="navbar-item" href="../../userguide/latest/commandlog/about.html">Command Log</a> |
| <a class="navbar-item" href="../../userguide/latest/docgen/about.html">Doc Gen</a> |
| <a class="navbar-item" href="../../userguide/latest/executionlog/about.html">Execution Log</a> |
| <a class="navbar-item" href="../../userguide/latest/executionoutbox/about.html">Execution Outbox</a> |
| <a class="navbar-item" href="../../userguide/latest/executionrepublisher/about.html">Execution Republisher</a> |
| <a class="navbar-item" href="../../userguide/latest/excel/about.html">Excel</a> |
| <a class="navbar-item" href="../../userguide/latest/flyway/about.html">Flyway</a> |
| <a class="navbar-item" href="../../userguide/latest/layoutloaders/about.html">Layout Loaders</a> |
| <a class="navbar-item" href="../../userguide/latest/titlecache/about.html">Title Cache</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Security</span> |
| <a class="navbar-item" href="../../security/latest/secman/about.html">Secman</a> |
| <a class="navbar-item" href="../../security/latest/audittrail/about.html">Audit Trail</a> |
| <a class="navbar-item" href="../../security/latest/spring-oauth2/about.html">Spring OAuth2 Integration</a> |
| <a class="navbar-item" href="../../security/latest/sessionlog/about.html">Session Log</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Web UI (Wicket)</span> |
| <a class="navbar-item" href="../../vw/latest/fullcalendar/about.html">Full Calendar</a> |
| <a class="navbar-item" href="../../vw/latest/pdfjs/about.html">pdf.js</a> |
| <a class="navbar-item" href="../../vw/latest/sse/about.html">Server Side Events</a> |
| <a class="navbar-item" href="../../vw/latest/tabular/about.html">Tabular Download</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">REST API (Restful Objects)</span> |
| <a class="navbar-item" href="../../vro/latest/cors/about.html">CORS</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Persistence</span> |
| <a class="navbar-item" href="../../querydsl/latest/about.html">QueryDSL</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Support</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Contact</span> |
| <a class="navbar-item" href="../../docs/latest/support/slack-channel.html">Slack</a> |
| <a class="navbar-item" href="../../docs/latest/support/mailing-list.html">Mailing Lists</a> |
| <a class="navbar-item" href="https://issues.apache.org/jira/browse/CAUSEWAY">JIRA</a> |
| <a class="navbar-item" href="https://stackoverflow.com/questions/tagged/causeway">Stack Overflow</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Releases</span> |
| <a class="navbar-item" href="../../docs/latest/downloads/how-to.html">Downloads</a> |
| <a class="navbar-item" href="../../relnotes/latest/about.html">Release Notes</a> |
| <hr class="navbar-divider"/> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Framework</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Process</span> |
| <a class="navbar-item" href="../../comguide/latest/about.html">Committers' Guide</a> |
| <a class="navbar-item" href="../../tooling/latest/about.html">Tooling</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Automated Analysis</span> |
| <a class="navbar-item" href="https://sonarcloud.io/dashboard?id=apache_causeway">SonarCloud.io</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Interim Builds</span> |
| <a class="navbar-item" href="../../comguide/latest/nightly-builds.html">Nightly builds</a> |
| <a class="navbar-item" href="../../comguide/latest/weekly-builds.html">Weekly builds</a> |
| <a class="navbar-item" href="https://apache-causeway-committers.github.io/causeway-nightly">Website Preview (not ASF hosted)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Development</span> |
| <a class="navbar-item" href="../../core/latest/about.html">Internal Design Docs</a> |
| <a class="navbar-item" href="../../regressiontests/latest/about.html">Regression Tests</a> |
| <a class="navbar-item" href="../../incubator/latest/about.html">Incubator</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Thanks</span> |
| <a class="navbar-item" href="../../more-thanks/latest/more-thanks.html">Acknowledgements</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">ASF</a> |
| <div class="navbar-dropdown"> |
| <a class="navbar-item" href="http://www.apache.org/">Apache Homepage</a> |
| <a class="navbar-item" href="https://www.apache.org/events/current-event">Events</a> |
| <a class="navbar-item" href="https://www.apache.org/licenses/">License</a> |
| <a class="navbar-item" href="https://www.apache.org/security/">Security</a> |
| <a class="navbar-item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a> |
| <a class="navbar-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a> |
| <a class="navbar-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a> |
| <hr class="navbar-divider"/> |
| <a class="navbar-item" href="https://whimsy.apache.org/board/minutes/Causeway.html">PMC board minutes</a> |
| </div> |
| </div> |
| <a class="navbar-item" href="../../docs/latest/about.html"> |
| <span class="icon"> |
| <img src="../../_/img/home.png"></img> |
| </span> |
| </a> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <div class="body "> |
| <div class="nav-container" data-component="comguide" data-version="2.0.0"> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-search hide-for-print"> |
| <input id="algolia-search-input" placeholder="Search"></span> |
| </div> |
| <div class="nav-panel-pagination"> |
| <a class="page-previous" rel="prev" href="about.html" title="Committers' Guide"><span></span></a> |
| <a class="page-next" rel="next" |
| href="applying-patches.html" title="Applying Patches"><span></span></a> |
| <!-- |
| page.parent doesn't seem to be set... |
| <a class="page-parent disabled" rel="prev" href="" title="Committers' Guide"><span></span></a> |
| --> |
| </div> |
| <div class="nav-panel-menu is-active" data-panel="menu"> |
| <nav class="nav-menu"> |
| <h3 class="title"><a href="about.html">Committers' Guide</a></h3> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Occasionally</span> |
| <ul class="nav-list"> |
| <li class="nav-item is-current-page" data-depth="2"> |
| <a class="nav-link" href="merging-a-pull-request.html">Merging a Pull Request</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="applying-patches.html">Applying Patches</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="updating-the-website.html">Updating the Website</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Nightly</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="nightly-builds.html">Nightly Builds</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="weekly-builds.html">Weekly Builds</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Release</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="cutting-a-release.html">Cutting a Release</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="verifying-releases.html">Verifying Releases</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Post Release</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="post-release-successful.html">Post Release (Successful)</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="post-release-unsuccessful.html">Post Release (Unsuccessful)</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Appendices</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="key-generation.html">Key Generation</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="algolia-search.html">Algolia Search</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="release-process-prereqs.html">Release Process Prereqs</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="policies.html">Policies</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="pmc-notes.html">PMC Notes</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </div> |
| <div class="nav-panel-explore" data-panel="explore"> |
| <div class="context"> |
| <span class="title">Committers' Guide</span> |
| <span class="version">2.0.0</span> |
| </div> |
| <ul class="components"> |
| <li class="component"> |
| <span class="title"> </span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../docs/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component is-current"> |
| <span class="title">Committers' Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version is-current"> |
| <a href="about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Contributors' Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../conguide/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Design Docs</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../core/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Extensions</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../extensions/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">GraphQL Viewer</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../gqlv/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Incubator Catalog</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../incubator/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JDO/DataNucleus</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../pjdo/latest/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JPA</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../pjpa/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">QueryDSL</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../querydsl/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../querydsl/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../querydsl/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../querydsl/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../querydsl/3.2.0/about.html">3.2.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Reference Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../refguide/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">regressiontests</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../regressiontests/latest/index.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.5.0/index.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.4.0/index.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.3.0/index.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.2.0/index.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.1.0/index.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.0.0/index.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/2.1.0/index.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/2.0.0/index.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Release Notes</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../relnotes/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">REST API (Restful Objects Viewer)</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../vro/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Security Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../security/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Setup Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../setupguide/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Testing Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../testing/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Tutorials</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../tutorials/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">User Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../userguide/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Value Types Catalog</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../valuetypes/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Web UI (Wicket Viewer)</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../vw/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </aside> |
| </div> |
| <main role="main"> |
| <div class="toolbar" role="navigation"> |
| <button class="nav-toggle"></button> |
| <a href="../../docs/latest/about.html" class="home-link"></a> |
| <nav class="breadcrumbs" aria-label="breadcrumbs"> |
| <ul> |
| <li><a href="about.html">Committers' Guide</a></li> |
| <li>Occasionally</li> |
| <li><a href="merging-a-pull-request.html">Merging a Pull Request</a></li> |
| </ul> |
| </nav> |
| <div class="page-versions"> |
| <button class="version-menu-toggle" title="Show other versions of page">2.0.0</button> |
| <div class="version-menu"> |
| <a class="version" href="../latest/merging-a-pull-request.html">4.0.0-M1</a> |
| <a class="version" href="../3.5.0/merging-a-pull-request.html">3.5.0</a> |
| <a class="version" href="../3.4.0/merging-a-pull-request.html">3.4.0</a> |
| <a class="version" href="../3.3.0/merging-a-pull-request.html">3.3.0</a> |
| <a class="version" href="../3.2.0/merging-a-pull-request.html">3.2.0</a> |
| <a class="version" href="../3.1.0/merging-a-pull-request.html">3.1.0</a> |
| <a class="version" href="../3.0.0/merging-a-pull-request.html">3.0.0</a> |
| <a class="version" href="../2.1.0/merging-a-pull-request.html">2.1.0</a> |
| <a class="version is-current" href="merging-a-pull-request.html">2.0.0</a> |
| </div> |
| </div> |
| <div class="edit-this-page"><a href="https://github.com/apache/causeway/edit/2.0.0/antora/components/comguide/modules/ROOT/pages/merging-a-pull-request.adoc">Edit</a></div> |
| </div> |
| <article class="doc"> |
| <a name="section-top"></a> |
| <h1 class="page">Merging a Pull Request</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The process for merging in github pull requests (so that they can be tested locally before committing) has been scripted in the <code>github-pr.sh</code> script.</p> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| Alternatively, if you are confident using <em>git</em> from within your IDE, |
| consider the specific IDE setup guides <a href="../../conguide/latest/eclipse/about.html" class="xref page">Eclipse</a> |
| and <a href="../../conguide/latest/intellij/about.html" class="xref page">IntelliJ</a>. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>The script will merge the fork into a temporary branch, and then run a build. |
| Once you are happy, you can commit.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="process-and-usage"><a class="anchor" href="#process-and-usage"></a>Process and Usage</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The overall process is as follows:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>locate/raise corresponding JIRA ticket, eg CAUSEWAY-1162</p> |
| </li> |
| <li> |
| <p>checkout branch from which PR was forked (usually just 'master')</p> |
| </li> |
| <li> |
| <p>merge PR into temporary branch using the <code>github-pr.sh</code> script</p> |
| </li> |
| <li> |
| <p>test the change locally (run the app, rebuild, manual regression tests etc)</p> |
| </li> |
| <li> |
| <p>if required, tidy up/refactor code as required</p> |
| </li> |
| <li> |
| <p>merge temporary branch into mainline, and commit</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>This <a href="https://youtu.be/CKSLZBBHjME">screencast</a> also shows the process.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="prerequisites"><a class="anchor" href="#prerequisites"></a>Prerequisites</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The script uses 'jq' to parse JSON. To install:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>on Linux:<br></p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">aptitude install jq</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>on MacOS:<br></p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">brew install jq</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>on Windows:<br></p> |
| <div class="paragraph"> |
| <p>Download exe from <a href="http://stedolan.github.io/jq/download/">website</a></p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="syntax"><a class="anchor" href="#syntax"></a>Syntax</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The syntax is:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">github-pr.sh -j 1162 -g 31 [-s] [-p CAUSEWAY]</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>where:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>-j 1162</code></p> |
| <div class="paragraph"> |
| <p>is the JIRA ticket number</p> |
| </div> |
| </li> |
| <li> |
| <p><code>-g 31</code></p> |
| <div class="paragraph"> |
| <p>is the github PR issue number</p> |
| </div> |
| </li> |
| <li> |
| <p><code>-s</code></p> |
| <div class="paragraph"> |
| <p>will optionally skip the build and auto-merge</p> |
| </div> |
| </li> |
| <li> |
| <p><code>-p CAUSEWAY</code></p> |
| <div class="paragraph"> |
| <p>optionally overrids the JIRA project (defaults to 'CAUSEWAY')</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="example-transcript"><a class="anchor" href="#example-transcript"></a>Example transcript</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The listing below shows the steps taken by the script:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ sh github-pr.sh causeway 1162 31 |
| |
| Found JIRA ticket |
| Found github PR |
| branch_name_local: master |
| username : sebadiaz |
| repo_full_name : sebadiaz/causeway |
| repo_clone_url : https://github.com/sebadiaz/causeway.git |
| branch_name_fork : master |
| |
| merging into: CAUSEWAY-1162_pr-31 |
| |
| Deleting branch 'CAUSEWAY-1162_pr-31' |
| Deleted branch CAUSEWAY-1162_pr-31 (was bd2e3c2). |
| Creating the branch CAUSEWAY-1162_pr-31 |
| Switched to a new branch 'CAUSEWAY-1162_pr-31' |
| Pulling the changes from https://github.com/sebadiaz/causeway.git master |
| From https://github.com/sebadiaz/causeway |
| * branch master -> FETCH_HEAD |
| Auto-merging core/pom.xml |
| Merge made by the 'recursive' strategy. |
| core/pom.xml | 3 +- |
| .../apache/causeway/security/shiro/CausewayLdapRealm.java | 198 +++++++++++++++++++-- |
| 2 files changed, 186 insertions(+), 15 deletions(-) |
| |
| Merged the PR; hit enter to build</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The build now commences. |
| Once done, the script continues:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">If build successful and happy to merge, execute: |
| |
| git checkout master && git merge --no-ff CAUSEWAY-1162_pr-31 && git branch -d CAUSEWAY-1162_pr-31</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The screenshot belows shows the history we end up with:</p> |
| </div> |
| <div class="imageblock"> |
| <div class="content"> |
| <img src="_images/committers/github-pr-history.png" alt="github pr history"> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This shows the fork being merged into the temporary branch ("CAUSEWAY-1162_pr-31"), then some further tidy-up, and finally the merging of the temporary branch into mainline.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Note that there is no rebasing in this model. |
| This is intentional: when the merged branch is pushed, github will automatically close the original pull request.</p> |
| </div> |
| </div> |
| </div> |
| </article> |
| <aside class="article-aside toc hide-for-print" role="navigation"> |
| <p class="toc-title">On this page</p> |
| <div id="article-toc"></div> |
| </aside> |
| </main> |
| </div> |
| <footer class="footer"> |
| <div class="content"> |
| <div class="copyright"> |
| <p> |
| Copyright © 2010~2024 The Apache Software Foundation, licensed under the Apache License, v2.0. |
| <br/> |
| Apache, the Apache feather logo, Apache Causeway, and the Apache Causeway project logo are all trademarks of The Apache Software Foundation. |
| </p> |
| </div> |
| <div class="revision"> |
| <p>Revision: build-website.20251118-0002</p> |
| </div> |
| </div> |
| </footer> |
| <script src="../../_/js/site.js"></script> |
| <script async src="../../_/js/vendor/highlight.js"></script> |
| <script src="../../_/js/vendor/jquery-3.4.1.min.js"></script> |
| <script src="../../_/js/vendor/jquery-ui-1.12.1.custom.widget-only.min.js"></script> |
| <script src="../../_/js/vendor/jquery.tocify.min.js"></script> |
| |
| <script> |
| $(function() { |
| $("#article-toc").tocify( { |
| showEffect: "slideDown", |
| hashGenerator: "pretty", |
| hideEffect: "slideUp", |
| selectors: "h2, h3", |
| scrollTo: 120, |
| smoothScroll: true, |
| theme: "jqueryui", |
| highlightOnScroll: true |
| } ); |
| }); |
| </script> |
| |
| <script src="../../_/js/vendor/docsearch.min.js"></script> |
| <script> |
| function focusSearchInput () { document.querySelector('#algolia-search-input').focus() } |
| var search = docsearch({ |
| appId: '5ISP5TFAEN', |
| apiKey: '0fc51c28b4ad46e7318e96d4e97fab7c', |
| indexName: 'causeway-apache-org', |
| inputSelector: '#algolia-search-input', |
| autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] }, |
| debug: false, |
| }).autocomplete |
| search.on('autocomplete:closed', function () { search.autocomplete.setVal() }) |
| focusSearchInput() |
| window.addEventListener('load', focusSearchInput); |
| </script> |
| |
| <!-- |
| docsearch options: |
| https://docsearch.algolia.com/docs/behavior/ |
| --> |
| <!-- |
| https://www.algolia.com/doc/api-reference/api-parameters/ |
| algoliaOptions: { hitsPerPage: 6 }, |
| --> |
| </body> |
| </html> |
