Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Invoke-JS7GitRepositoryCommit

SYNOPSIS

Commits any staged changes to the local repository

SYNTAX

Invoke-JS7GitRepositoryCommit [-Folder] <String> [-Local] [-Message] <String> [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

This cmdlet commits changes that have previously been added to a local repository.
Typically this cmdlet is used after changes have been staged by use of the Invoke-JS7GitRepositoryAdd cmdlet.

This cmdlet corresponds to using the following Git command:

* git commit -m 'changes for release v.1.13'

The following REST Web Service API resources are used:

* /inventory/repository/git/commit

PARAMETERS

Folder

-Folder <String>
Specifies the JOC Cockpit inventory folder that maps to the Git repository.

Required?true
Position?1
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Local

-Local <SwitchParameter>
Specifies that a repository holding scheduling objects that are local to the environment should be used.
This corresponds to the LOCAL category. If this switch is not used then the
ROLLOUT category is assumed for a repository that holds scheduling objects
intended for rollout to later environments such as test, prod.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Message

-Message <String>
The commmit message typically specifies a comment or identifier for the changes added.

Required?true
Position?2
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

AuditComment

-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.

The Audit Comment is visible from the Audit Log view of the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.

Required?false
Position?3
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

AuditTimeSpent

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.

Required?false
Position?4
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JS7.

This information is shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JS7.

Required?false
Position?5
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > Invoke-JS7GitRepositoryCommit -Folder /TestCases -Message 'changes for release v1.13'

Commits changes that have been performed to the local repository to the repository staging area. The local repository is mapped to the /TestCases inventory folder in JOC Cockpit.