Skip to content

Commit

Permalink
Add description to POM files, minor README changes (#16)
Browse files Browse the repository at this point in the history
* Description changes in poms. README edits.

* Different name than the repo URL is confusing

* Use release drafter as changelog. More naming.

* Please can we never rename a plugin ever again

* No really.

* Forget the little buttons at the top for now

* Revert "Forget the little buttons at the top for now"

This reverts commit e5fc787.

* Now they all finally work

* Make poms match index.jelly. Remove stray copypasta from README. Grammar.
  • Loading branch information
kshultzCB committed Feb 11, 2020
1 parent a467c77 commit 0a25c8b
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 4 deletions.
11 changes: 9 additions & 2 deletions README.md
@@ -1,11 +1,18 @@
## Declarative Pipeline Migration Assistant
This project includes a plugin that uses details from a Freestyle project to generate a starting Jenkinsfile.The Declarative Pipeline Migration Assistant plugin uses a “best effort” approach during generation, which means supported configurations in Freestyle projects will be automatically converted, and placeholder stages will be created for plugins that are not yet supported.

[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/declarative-pipeline-migration-assistant)](https://plugins.jenkins.io/declarative-pipeline-migration-assistant)
[![Changelog](https://img.shields.io/github/v/tag/jenkinsci/convert-to-declarative?label=changelog)](https://github.com/jenkinsci/declarative-pipeline-migration-assistant-plugin/releases)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/declarative-pipeline-migration-assistant?color=blue)](https://plugins.jenkins.io/declarative-pipeline-migration-assistant)
[![Contributors](https://img.shields.io/github/contributors/jenkinsci/convert-to-declarative.svg)](https://github.com/jenkinsci/declarative-pipeline-migration-assistant-plugin/graphs/contributors)

This project includes a plugin that uses details from a Freestyle project to generate a starting Jenkinsfile. The Declarative Pipeline Migration Assistant plugin uses a “best effort” approach during generation, which means supported configurations in Freestyle projects will be automatically converted, and placeholder stages will be created for plugins that are not yet supported.

There are two modules in the project:
- The plugin which uses the API to generate a Jenkinsfile based on a Freestyle project
- The API (the base of extension points to convert different parts of a Freestyle project)

You can find more documentation on the Cloudbees documentation site [http://cloudbees.com/r/declarative-pipeline-migration-assistant](http://cloudbees.com/r/declarative-pipeline-migration-assistant)
Documentation for this plugin is hosted on
[the CloudBees documentation site](https://docs.cloudbees.com/docs/admin-resources/latest/pipelines-user-guide/declarative-pipeline-migration-assistant).

### The plugin
For further details on using the plugin, please see Converting a Freestyle project to a Declarative Pipeline.
Expand Down
2 changes: 1 addition & 1 deletion declarative-pipeline-migration-assistant-api/pom.xml
Expand Up @@ -10,7 +10,7 @@
<version>1.0.1-SNAPSHOT</version>
<packaging>hpi</packaging>
<name>Declarative Pipeline Migration Assistant API</name>
<description>TODO</description>
<description>Declarative Pipeline Migration Assistant API (this plugin contains APIs used to convert Freestyle Jobs into Declarative Pipelines).</description>

<dependencies>
<dependency>
Expand Down
@@ -1,4 +1,4 @@
<?jelly escape-by-default='true'?>
<div>
Declarative Pipeline Migration Assistant API (this plugin contains API used to convert jobs to declarative pipeline).
Declarative Pipeline Migration Assistant API (this plugin contains APIs used to convert Freestyle Jobs into Declarative Pipelines).
</div>
1 change: 1 addition & 0 deletions declarative-pipeline-migration-assistant/pom.xml
Expand Up @@ -10,6 +10,7 @@
<version>1.0.1-SNAPSHOT</version>
<packaging>hpi</packaging>
<name>Declarative Pipeline Migration Assistant</name>
<description>Declarative Pipeline Migration Assistant Plugin.</description>

<dependencies>
<dependency>
Expand Down
1 change: 1 addition & 0 deletions pom.xml
Expand Up @@ -37,6 +37,7 @@
<version>1.0.1-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Declarative Pipeline Migration Assistant</name>
<description>Declarative Pipeline Migration Assistant Plugin.</description>

<url>https://github.com/jenkinsci/declarative-pipeline-migration-assistant-plugin</url>

Expand Down

0 comments on commit 0a25c8b

Please sign in to comment.