Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
**NOTE**

The built-in DSL is in [Maintenance Mode](https://en.wikipedia.org/wiki/Maintenance_mode). If a feature is available in
[Dynamic DSL](docs/Dynamic-DSL.md), it will not be added to the built-in DSL. Any pull requests or JIRA tickets for
[Dynamic DSL](docs/Dynamic-DSL.md), it will not be added to the built-in DSL. Any pull requests or issues for
adding support for features that are available in Dynamic DSL will be rejected.
---

Expand All @@ -25,13 +25,11 @@ the [Dynamic DSL](docs/Dynamic-DSL.md). Feature requests or pull requests for fe
already supported by dynamic DSL are likely to be rejected since it's not feasible to add support for
every config option of each of the 1000+ plugins available in the Update Center.

* Feature Requests - Create a "New Feature" issue on the
[Jenkins JIRA](https://issues.jenkins-ci.org/secure/Dashboard.jspa?selectPageId=15341). Remember to add the `job-dsl-plugin`
component.
* Feature Implementations - Even better than a JIRA issue is an implementation. If the implementation requires design
* Feature Requests - Create a ["Feature request" issue](https://github.com/jenkinsci/job-dsl-plugin/issues).
* Feature Implementations - An implementation is Even better than an issue. If the implementation requires design
or architectural changes or would need refactoring, send a mail to the
[group](https://groups.google.com/forum/?fromgroups#!forum/job-dsl-plugin) with a proposal. Otherwise simply fork
the repo, create a branch (named after the JIRA "New Feature" you created earlier), implement it yourself and submit a
the repo, create a branch, implement it yourself and submit a
Pull Request.
* Open a feature request for adding support for a specific plugin only if the plugin is not supported by the
[Dynamic DSL](docs/Dynamic-DSL.md) and if the plugin does not implement the
Expand All @@ -40,11 +38,8 @@ every config option of each of the 1000+ plugins available in the Update Center.

### Bugs

* Bug Reports - Create a new "Bug" issue on the
[Jenkins JIRA](https://issues.jenkins-ci.org/secure/Dashboard.jspa?selectPageId=15341). Remember to add the `job-dsl-plugin`
component.
* Bug Fixes - Even better than a JIRA issue is a fix. Simply fork our repo, create a branch (named after the JIRA "Bug"
you created earlier), implement it yourself and submit a Pull Request.
* Bug Reports - Create a new ["Bug report" issue](https://github.com/jenkinsci/job-dsl-plugin/issues).
* Bug Fixes - A fix is even better than an issue. Simply fork our repo, create a branch, implement it yourself and submit a Pull Request.

## Our Git Protocol

Expand All @@ -53,7 +48,7 @@ GitHub account in order to do this):

1. Fork the `jenkinsci/job-dsl-plugin` repository to your account.
2. On your local machine, clone your copy of the `job-dsl-plugin` repo.
3. Again on your local machine, create a branch, ideally named after a JIRA issue you've created for the work.
3. Again on your local machine, create a branch, ideally named after the issue you've created for the work.
4. Switch to the local branch and make your changes. When you're happy, commit them and push them to your repo branch.
5. Also update the documentation (including examples) and add tests as part of your changes.
6. Then, on the GitHub website, find the branch you created for your work, and submit a Pull Request. This will then
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,8 @@ about Job DSL. If you have a talk or blog post to share, please raise a hand, e.
Head over to [Stack Overflow](https://stackoverflow.com/questions/tagged/jenkins-job-dsl) or the
[mailing list](https://groups.google.com/d/forum/job-dsl-plugin) to get help.

Use the [Issue Tracker](https://issues.jenkins-ci.org/secure/Dashboard.jspa?selectPageId=15341) for reporting bugs and
making feature requests. Select the `job-dsl-plugin` component when searching or creating issues.
Use the [Issue Tracker](https://github.com/jenkinsci/job-dsl-plugin/issues) for reporting bugs and
making feature requests.

You can actively help to improve Job DSL by contributing code, documentation and tests or by reviewing and testing
upcoming changes on [GitHub](https://github.com/jenkinsci/job-dsl-plugin). Start by reading the
Expand Down
2 changes: 1 addition & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ These are the steps to release the Maven-based Job DSL plugin.
* Edit the [draft release notes](https://github.com/jenkinsci/job-dsl-plugin/releases) and publish them
* Run the [Push to the GitHub Wiki](https://github.com/jenkinsci/job-dsl-plugin/actions/workflows/wiki.yml) workflow to update the wiki with the new version
* Open a pull request to add the newly-released version to the API viewer in `job-dsl-plugin/pom.xml` and `job-dsl-plugin/src/main/hbs/root.hbs`
* Close all resolved issues in [JIRA](https://issues.jenkins-ci.org/secure/Dashboard.jspa?selectPageId=15341)
* Close all resolved issues in [GitHub](https://github.com/jenkinsci/job-dsl-plugin/issues)
* Open a pull request to update the [Job DSL Playground](https://github.com/sheehan/job-dsl-playground)
* Open a pull request to update the [Job DSL Gradle Example](https://github.com/sheehan/job-dsl-gradle-example)
* Open a pull request to update the [Job DSL Sample](https://github.com/unguiculus/job-dsl-sample)
Expand Down
2 changes: 1 addition & 1 deletion docs/Dynamic-DSL.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Dynamic methods are marked with a purple "Dynamic" tag. The dynamic DSL is *not*
If a methods is marked as required in the API viewer, it must be specified within it's context.

The following example shows a DSL script for using the dynamic DSL to configure the
[CVS Plugin](https://wiki.jenkins-ci.org/display/JENKINS/CVS+Plugin).
[CVS Plugin](https://plugins.jenkins.io/cvs/).

job('example') {
scm {
Expand Down
2 changes: 1 addition & 1 deletion docs/Extending-the-DSL.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,4 +249,4 @@ configuration can be changed at Manage Jenkins > System Log, e.g. by adding a ne

The following plugins implement the extension point and serve as examples:

* [JGiven Plugin](https://wiki.jenkins-ci.org/display/JENKINS/JGiven+Plugin)
* [JGiven Plugin](https://plugins.jenkins.io/jgiven/)
13 changes: 6 additions & 7 deletions docs/Handling-Credentials.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
There are three options for handling credentials and other secrets in Job DSL scripts.

The first option involves the [Credentials Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Credentials+Plugin) which
The first option involves the [Credentials Plugin](https://plugins.jenkins.io/credentials/) which
manages credentials in a secure manner and allows Job DSL scripts to reference credentials by their identifier. It is
also the most secure option because the credentials do not need to passed to the Job DSL script.

Expand All @@ -14,13 +14,12 @@ The following sections show how to handle credentials in detail.

## The Credentials Plugin

The [Credentials Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Credentials+Plugin) adds a new menu entry called
The [Credentials Plugin](https://plugins.jenkins.io/credentials/) adds a new menu entry called
"Credentials" to the top-level Jenkins navigation, next to "Manage Jenkins". The Credentials page allows to manage
credentials for any plugins that can consume these credentials., e.g. the [Git
Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin) or the [Subversion
Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Subversion+Plugin).
Plugin](https://plugins.jenkins.io/git/) or the [Subversion Plugin](https://plugins.jenkins.io/subversion/).

The [Credentials Binding Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Credentials+Binding+Plugin) can be used to
The [Credentials Binding Plugin](https://plugins.jenkins.io/credentials-binding/) can be used to
assign credentials to build variables. These can be used in shell scripts or other plugins that can consume build
variables but no credentials from the Credentials Plugin.

Expand Down Expand Up @@ -63,7 +62,7 @@ The Job DSL allows to specify the credentials' ID as a reference when when confi

All build variables are exposed to the Job DSL scripts as variables, see [User Power
Moves](User-Power-Moves#access-the-jenkins-environment-variables). There are several ways to define credentials as
build variables, e.g. the [EnvInject Plugin](https://wiki.jenkins-ci.org/display/JENKINS/EnvInject+Plugin) provides a
build variables, e.g. the [EnvInject Plugin](https://plugins.jenkins.io/envinject/) provides a
"Inject passwords to the build as environment variables" setting to inject passwords either defined globally in
"Configure System" or directly on a job.

Expand Down Expand Up @@ -111,5 +110,5 @@ like build variables as in the examples above.
}

A drawback of using global passwords is that all credentials are injected into the job and not only the ones needed to
run the job. The [Credentials Binding Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Credentials+Binding+Plugin)
run the job. The [Credentials Binding Plugin](https://plugins.jenkins.io/credentials-binding/)
allows more fine-grained access to credentials.
Loading
Loading