Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Merge pull request #6 from znerd/JENKINS-49559
JENKINS-49559: Initial version of README.md file.
- Loading branch information
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
[![][ButlerImage]][homepage] | ||
|
||
# About | ||
This is the source repository for the **File System SCM** plugin for Jenkins. | ||
This plugin provides an additional SCM option to Jenkins, based on the file | ||
system. | ||
|
||
For more information see the [homepage]. | ||
|
||
# Purpose and Use Cases | ||
|
||
Use this plugin if you want to use the Jenkins SCM (source code management) | ||
functionality, but instead of retrieving code from a version control system such | ||
as CVS, Subversion or git, instead retrieve the code from a directory on the | ||
file system. | ||
|
||
A typical use case is: during development of a Jenkins job (e.g. a pipeline), | ||
you don't need/want to connect to an actual version control system, but avoid | ||
the latency by just getting things from the local file system. | ||
|
||
# How to Raise Issues | ||
|
||
If you find any bug, or if you want to file a change request, then please | ||
check out: | ||
[How to report an issue](https://wiki.jenkins.io/display/JENKINS/How+to+report+an+issue). | ||
|
||
When creating a ticket in the [Jenkins JIRA](https://issues.jenkins-ci.org/) | ||
system, select the component `filesystem_scm_plugin`. | ||
|
||
# Source | ||
The source code can be found on | ||
[GitHub](https://github.com/jenkinsci/filesystem_scm-plugin). Fork us! | ||
|
||
# Contributing | ||
|
||
Contributions are welcome! Check out the | ||
[open tickets](https://issues.jenkins-ci.org/issues/?jql=project%20%3D%20JENKINS%20AND%20status%20in%20%28Open%2C%20Reopened%29%20AND%20component%20%3D%20filesystem_scm-plugin) | ||
for this plugin in JIRA. | ||
|
||
If you are a newbie, and want to pick up an easier task first, you may | ||
want to start with | ||
[newbie-friendly open tickets](https://issues.jenkins-ci.org/issues/?jql=project%20%3D%20JENKINS%20AND%20status%20in%20%28Open%2C%20Reopened%29%20AND%20component%20%3D%20filesystem_scm-plugin%20AND%20labels%20%3D%20newbie-friendly) | ||
first (if there are any). | ||
|
||
[ButlerImage]: https://jenkins.io/sites/default/files/jenkins_logo.png | ||
[homepage]: https://plugins.jenkins.io/filesystem_scm |