Skip to content

Commit bb099a9

Browse files
authored
Merge pull request #39 from dwnusbaum/migrate-wiki-content
Migrate wiki content to GitHub and add 2.10 release notes
2 parents 62e2f6c + ccd41d1 commit bb099a9

File tree

3 files changed

+116
-11
lines changed

3 files changed

+116
-11
lines changed

CHANGELOG.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
## Changelog
2+
3+
### 2.10
4+
5+
Release date: 2020-01-22
6+
7+
- Fix: When using the `checkout` step with `changelog: true` (the default), if
8+
the SCM leaves the changelog file completely empty, delete it instead of
9+
passing the empty changelog file to other APIs. ([JENKINS-59560](https://issues.jenkins-ci.org/browse/JENKINS-59560), [JENKINS-57918](https://issues.jenkins-ci.org/browse/JENKINS-57918))
10+
11+
### 2.9
12+
13+
Release date: 2019-06-07
14+
15+
- Fix: Use `rw-r--r--` (0644) permissions for changelog files on Posix
16+
systems as in version 2.7 and earlier of this plugin rather
17+
than `rw------- (0600)` as used in version 2.8 to avoid potential
18+
issues related to backups and similar scenarios. ([PR
19+
34](https://github.com/jenkinsci/workflow-scm-step-plugin/pull/34))
20+
21+
### 2.8
22+
23+
Release date: 2019-06-05
24+
25+
- Fix: Prevent SAXParseException from being thrown when using
26+
the `checkout` step in parallel blocks.
27+
([JENKINS-34313](https://issues.jenkins-ci.org/browse/JENKINS-34313))
28+
29+
### 2.7
30+
31+
Release date: 2018-10-01
32+
33+
- Fix: Prevent ConcurrentModificationException when using
34+
the `checkout` step in parallel blocks.
35+
([JENKINS-47201](https://issues.jenkins-ci.org/browse/JENKINS-47201))
36+
- Improvement: Change the display name of the `checkout` step from
37+
"General SCM" to "Check out from version control".
38+
- Improvement: Add documentation for specific variables returned by
39+
the `checkout` step based on the installed set of plugins.
40+
([JENKINS-26100](https://issues.jenkins-ci.org/browse/JENKINS-26100))
41+
42+
### 2.6
43+
44+
Release date: 2017-06-20
45+
46+
- [JENKINS-26100](https://issues.jenkins-ci.org/browse/JENKINS-26100) `checkout`
47+
step now returns a `Map` of environment variables set by the SCM in
48+
legacy Freestyle jobs, such as `GIT_COMMIT` and `SVN_REVISION`.
49+
50+
### 2.5
51+
52+
Release date: 2017-06-16
53+
54+
- No user-facing changes.
55+
56+
### 2.4
57+
58+
Release date: 2017-02-27
59+
60+
- No user-facing changes, only test infrastructure.
61+
62+
### 2.3
63+
64+
Release date: 2016-11-10
65+
66+
- No user-facing changes, only internal metadata.
67+
68+
### 2.2
69+
70+
Release date: 2016-07-05
71+
72+
- [JENKINS-35247](https://issues.jenkins-ci.org/browse/JENKINS-35247)
73+
`git` and `svn` steps now moved to their respective SCM plugins.
74+
This plugin now includes only the generic `checkout` step.
75+
76+
### 2.1
77+
78+
Release date: 2016-06-09
79+
80+
- [JENKINS-35247](https://issues.jenkins-ci.org/browse/JENKINS-35247)
81+
Removed direct plugin dependencies on [Git
82+
Plugin](https://plugins.jenkins.io/git) and
83+
[Subversion
84+
Plugin](https://plugins.jenkins.io/subversion),
85+
in preparation for moving the `git` and `svn` steps to their natural
86+
homes. (forward-ported from 1.14.2 / 1.4.3)
87+
- Downgraded “overriding old revision state” warning.
88+
89+
### 2.0
90+
91+
Release date: 2016-04-05
92+
93+
- First release under per-plugin versioning scheme. See [1.x
94+
changelog](https://github.com/jenkinsci/workflow-plugin/blob/82e7defa37c05c5f004f1ba01c93df61ea7868a5/CHANGES.md)
95+
for earlier releases.

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
# Introduction
1+
# Pipeline: SCM Step Plugin
2+
3+
[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/workflow-scm-step)](https://plugins.jenkins.io/workflow-scm-step)
4+
[![Changelog](https://img.shields.io/github/v/tag/jenkinsci/workflow-scm-step-plugin?label=changelog)](https://github.com/jenkinsci/workflow-scm-step-plugin/blob/master/CHANGELOG.md)
5+
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/workflow-scm-step?color=blue)](https://plugins.jenkins.io/workflow-scm-step)
6+
7+
## Introduction
28

39
This plugin allows pipelines to use standard Jenkins SCM plugins to check out source code.
410
The goals are the maximum possible compatibility with existing plugins, and great flexibility for script authors.
511

6-
# Features
12+
## Features
713

814
A freestyle project has a single SCM configured in the UI that governs the one and only workspace for the build.
915
A Pipeline can be configured similarly, but the SCM definition becomes a regular step in its script.
@@ -19,7 +25,7 @@ node {
1925
Jenkins will clone the repository into the workspace and continue with your script.
2026
(Subsequent builds will update rather than clone, if the same slave and workspace are available again.)
2127

22-
## Multiple SCMs
28+
### Multiple SCMs
2329

2430
While freestyle projects can use the Multiple SCMs plugin to check out more than one repository,
2531
or specify multiple locations in SCM plugins that support that (notably the Git plugin),
@@ -38,7 +44,7 @@ parallel repos.collectEntries {repo -> [/* thread label */repo, {
3844
}]}
3945
```
4046

41-
## Changelogs
47+
### Changelogs
4248

4349
By default each build will show changes from the previous build in its changelog as usual, and you can see an overall changelog on the project index page.
4450
You may specify `changelog: false` to disable changelog generation if it is not of interest, or too large to compute efficiently.
@@ -47,7 +53,7 @@ Jenkins will automatically remember the SCMs run in the _last build_ of the proj
4753
This means that you can run multiple SCMs, even from a dynamic list, and get a reasonable changelog.
4854
(At least for those checkouts that remain constant from build to build, as identified by a key defined by the SCM plugin, typically based on something like the repository location and branch.)
4955

50-
## Polling
56+
### Polling
5157

5258
If you configure the _Poll SCM_ trigger in the Pipeline’s UI configuration screen, then by default Jenkins will also poll for changes according to the selected _Schedule_, and schedule new builds automatically if changes are detected.
5359
(Note that this configuration is not part of the Pipeline script, because it affects activities that Jenkins runs outside of the Pipeline.)
@@ -61,15 +67,15 @@ Polling is supported across multiple SCMs (changes in one or more will trigger a
6167

6268
You may specify `poll: false` to disable polling for an SCM checkout.
6369

64-
# Built-in integrations
70+
## Built-in integrations
6571

6672
Currently there are special integrations in the Git (`git` step) and Subversion (`svn` step) plugins.
6773
See those plugins for details.
6874

69-
# Generic SCM step
75+
## Generic SCM step
7076

7177
The `checkout` step may be used to run any other SCM plugin, provided that it has been brought up to date as described below.
72-
(See the [compatibility list](https://github.com/jenkinsci/pipeline-plugin/blob/master/COMPATIBILITY.md) for the list of currently SCMs.)
78+
(See the [compatibility list](https://github.com/jenkinsci/pipeline-plugin/blob/master/COMPATIBILITY.md) for the list of currently supported SCMs.)
7379
It could also be used to run an SCM for which there is a special integration that lacks support for an exotic feature.
7480
The step takes an `scm` parameter which is a map containing at least a `$class` parameter giving the full or simple class name of the desired `SCM` implementation, and the standard `poll` and `changelog` parameters.
7581

@@ -101,6 +107,10 @@ This would correspond roughly to a freestyle project whose `config.xml` includes
101107

102108
with no `<hudson.triggers.SCMTrigger>` (polling).
103109

104-
# Supporting Pipeline from an SCM plugin
110+
## Supporting Pipeline from an SCM plugin
111+
112+
See the [compatibility guide](https://jenkins.io/doc/developer/plugin-development/pipeline-integration/#scms).
113+
114+
## Version History
105115

106-
See the [compatibility guide](https://github.com/jenkinsci/pipeline-plugin/blob/master/DEVGUIDE.md#scms).
116+
See [the changelog](CHANGELOG.md).

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<version>${revision}${changelist}</version>
1313
<packaging>hpi</packaging>
1414
<name>Pipeline: SCM Step</name>
15-
<url>https://wiki.jenkins-ci.org/display/JENKINS/Pipeline+SCM+Step+Plugin</url>
15+
<url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>
1616
<licenses>
1717
<license>
1818
<name>MIT License</name>

0 commit comments

Comments
 (0)