Skip to content

Commit

Permalink
Add help icon for stream at change.
Browse files Browse the repository at this point in the history
Update docs for stream at change
  • Loading branch information
skumar7322 committed Nov 10, 2023
1 parent d92fb0d commit 0eb4437
Show file tree
Hide file tree
Showing 9 changed files with 45 additions and 22 deletions.
48 changes: 29 additions & 19 deletions docs/WORKFLOW.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,32 +31,42 @@ the path in another Workspaces View, or 'Depot path' to refer to a classic depot
This generated the following snippet...

```groovy
p4sync(charset: 'none',
credential: 'phooey1666',
populate: [$class: 'AutoCleanImpl',
delete: true,
modtime: false,
pin: '',
quiet: true,
replace: true],
stream: '//streams/st1-main')
p4sync(
charset: 'none',
credential: 'Local Perforce 20231',
format: 'jenkins-${NODE_NAME}-${JOB_NAME}-${EXECUTOR_NUMBER}',
populate: autoClean(
delete: true,
modtime: false,
parallel: [enable: false, minbytes: '1024', minfiles: '1', threads: '4'],
pin: '',
quiet: true,
replace: true,
tidy: false),
source: streamSource('//streams-depot/StreamA')
)
```

and you can paste it into a basic script. For example:

```groovy
node {
stage('Sync') {
// sync files from //streams/st1-main/...
p4sync(charset: 'none',
credential: 'phooey1666',
populate: [$class: 'AutoCleanImpl',
delete: true,
modtime: false,
pin: '',
quiet: true,
replace: true],
stream: '//streams/st1-main')
// sync files from //streams-depot/StreamA/...
p4sync(
charset: 'none',
credential: 'Local Perforce 20231',
format: 'jenkins-${NODE_NAME}-${JOB_NAME}-${EXECUTOR_NUMBER}',
populate: autoClean(
delete: true,
modtime: false,
parallel: [enable: false, minbytes: '1024', minfiles: '1', threads: '4'],
pin: '',
quiet: true,
replace: true,
tidy: false),
source: streamSource('//streams-depot/StreamA')
)
}
}
```
Expand Down
5 changes: 3 additions & 2 deletions docs/WORKSPACEMANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ For more information about variables, see [Variable Expansion](VARIABLEEXPANSION
- **READONLY:** select readonly to give the client its own personal db.have database table. A readonly client cannot edit or submit files. For build automation this is not usually a requirement and the performance tradeoff is worth considering if your build automation is causing issues with the db.have table. The client.readonly.dir setting must be configured by an administrator before using this option.
- **PARTITIONED:** select if changes are submitted as part of your build. You can specify a partitioned client like a readonly client. This type also has a separate db.have table under the client.readonly.dir directory, but allows journaled edit and submit of files.
8. **Stream:** if using streams, specify the full Perforce depot path for the stream that will be used to create or update the Jenkins build workspace. If you are connected to a Helix Server, streams will be auto suggested as you type.
9. **View Mappings:** displays the mapping of the depot files to your client workspace. This defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. For information about the view syntax, see [Client Views](https://www.perforce.com/perforce/doc.current/manuals/cmdref/index.html#CmdRef/views.html) in the [P4 Command Reference Guide](https://www.perforce.com/perforce/doc.current/manuals/cmdref/index.html#CmdRef/about.html). A new view takes effect on the next `p4 sync`.
10. **Server ID:** if set, restricts usage to the named server. If unset, usage is allowed on the master Helix Server and on any replicas of the master other than Edge Servers.
9. **Stream at change:** when specified the client view is generated from the stream specification version at or before the change number.
10. **View Mappings:** displays the mapping of the depot files to your client workspace. This defines the files that you want in your client workspace and specifies where you want them to reside. The default view maps all depot files onto the client. For information about the view syntax, see [Client Views](https://www.perforce.com/perforce/doc.current/manuals/cmdref/index.html#CmdRef/views.html) in the [P4 Command Reference Guide](https://www.perforce.com/perforce/doc.current/manuals/cmdref/index.html#CmdRef/about.html). A new view takes effect on the next `p4 sync`.
11. **Server ID:** if set, restricts usage to the named server. If unset, usage is allowed on the master Helix Server and on any replicas of the master other than Edge Servers.

Click the browser **Back** button to go back to the previous page.
2 changes: 1 addition & 1 deletion docs/WORKSPACESTREAMS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Uses a specified template to generate the workspace view. The name of the worksp
1. **Workspace behaviour:** select **Streams (view generated by Perforce for each node)** from the dropdown list.
2. **Character Set:** sets the character set used by Jenkins when syncing files from the Perforce Helix Core Server. This should be set to **none** unless the workspace is connected to a Unicode enabled Helix Server.
3. **Stream Codeline:** specify the full Perforce depot path for the stream that will be used to create or update the Jenkins build workspace. If you are connected to a Helix Server, streams will be auto suggested as you type.
4. **Pin the workspace to the build host:** this can usually be left unselected because the `${NODE_NAME}` variable in the **Workspace Name Format** field does this for you.
4. **Stream at change:** when specified the client view is generated from the stream specification version at or before the change number.
5. **Workspace Name Format:** Jenkins slave nodes must each use a unique Perforce workspace. The format string configures the workspace name by substituting the specified variables. At least one variable must be used, but it is recommended that, as a minimum, the following variables are used:
```
jenkins-${NODE_NAME}-${JOB_NAME}-${EXECUTOR_NUMBER}
Expand Down
Binary file modified docs/images/manualworkspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/p4sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/streamsworkspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<div>
<b>Stream at change</b>
<p>when specified the client view is generated from the stream specification version at or before the change number.</p>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<div>
<b>Stream at change</b>
<p>when specified the client view is generated from the stream specification version at or before the change number.</p>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<div>
<b>Stream at change</b>
<p>when specified the client view is generated from the stream specification version at or before the change number.</p>
</div>

0 comments on commit 0eb4437

Please sign in to comment.