jenkinsci/hpe-application-automation-tools-plugin

<!--
 ~ Certain versions of software accessible here may contain branding from Hewlett-Packard Company (now HP Inc.) and Hewlett Packard Enterprise Company.
 ~ This software was acquired by Micro Focus on September 1, 2017, and is now offered by OpenText.
 ~ Any reference to the HP and Hewlett Packard Enterprise/HPE marks is historical in nature, and the HP and Hewlett Packard Enterprise/HPE marks are the property of their respective owners.
 ~ __________________________________________________________________
 ~ MIT License
 ~
 ~ Copyright 2012-2024 Open Text
 ~
 ~ The only warranties for products and services of Open Text and
 ~ its affiliates and licensors ("Open Text") are as may be set forth
 ~ in the express warranty statements accompanying such products and services.
 ~ Nothing herein should be construed as constituting an additional warranty.
 ~ Open Text shall not be liable for technical or editorial errors or
 ~ omissions contained herein. The information contained herein is subject
 ~ to change without notice.
 ~
 ~ Except as specifically indicated otherwise, this document contains
 ~ confidential information and a valid license is required for possession,
 ~ use or copying. If this work is provided to the U.S. Government,
 ~ consistent with FAR 12.211 and 12.212, Commercial Computer Software,
 ~ Computer Software Documentation, and Technical Data for Commercial Items are
 ~ licensed to the U.S. Government under vendor's standard commercial license.
 ~
 ~ Unless required by applicable law or agreed to in writing, software
 ~ distributed under the License is distributed on an "AS IS" BASIS,
 ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 ~ See the License for the specific language governing permissions and
 ~ limitations under the License.
 ~ ___________________________________________________________________
  -->

<div>
    This step is responsible for collecting pull requests from the SCM tool and injecting them to ALM Octane.
    See help information in  <a target="_blank" href="https://admhelp.microfocus.com/octane/en/latest/Online/Content/UserGuide/articles-pull-requests.htm">ALM Octane Help Center</a>.
    <br>
    <br>
    In addition, this step is used to define the scm repositories templates that are used by ALM Octane to link to your repository viewer. To configure templates in ALM Octane, access Settings > Spaces. Select a workspace and click DevOps > SCM Repositories. Follow the on-screen instructions.
    <br>
    <br>
    Every time pull requests are sent to ALM Octane the last update time is saved. The next time, only pull requests and commits that were updated after this time will be sent to ALM Octane.

    <br>
    <br>
    Supported version of ALM Octane: 15.0.49 and later.


    <br>
    <br>
    You can change the behaviour of this step by adding the following parameters to the job:
    <ul>
        <li><b>pullrequests_min_update_time</b>: Use this parameter to override the last update time that is updated after each successful injection to ALM Octane.</li><br>
        <li><b>pullrequests_max_pr_to_collect</b>: Max number of pull requests to collect. Default is 100.</li><br>
        <li><b>pullrequests_max_commits_to_collect</b>: Max number of commits to collect for each pull request. Default is 100.</li><br>
    </ul>

    <br>
    <br>

    <b>Supported SCM Tools: </b>
    <br>
    <table border="1" width="100%" style="border-collapse: collapse;border: 1px solid black;">

        <thead style="background-color: lightgray; font-weight: bold">
        <tr>
            <td>SCM Tool</td>
            <td>Supported types of authentication</td>
            <td>How to create PAT (Personal access token)</td>
        </tr>
        </thead>
        <tbody>
        <tr>
            <td>Bitbucket Server</td>
            <td>User/password and PAT</td>
            <td>Click on your profile icon -> Manage account -> Personal access tokens -> Create a token (Assign Read permissions for both Projects and Repositories)</td>
        </tr>
        <tr>
            <td>Github Cloud</td>
            <td>PAT only</td>
            <td rowspan="2">Click on your profile icon -> Settings -> Developer settings -> Personal access tokens -> Generate new token (Uncheck all scopes to grants read-only access)</td>
        </tr>
        <tr>
            <td>Github Server</td>
            <td>User/password and PAT</td>
        </tr>
        </tbody>
    </table>
    <br>
    Note : To create PAT credentials in Jenkins , use "Secret text" kind of credentials in "Add Credentials" dialog

</div>