Child pages
  • XComment.io - Comments Remover Plugin

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

User can specify Python path in global settings for the plugin (otherwise the one on the system PATH is used).

Contributors

Daniel Dyląg

Konstantin Paraschevin 

For users

Global settings

Go to Manage Jenkins -> Configure System to access them

...

There is help section to provide examples:

settings

Usage

The plugin can be used wherever build steps can be defined, e.g. Freestyle project

...

This part also has "help" section:

build step help

Example of build output and result:

build output

build result

build result

Using as a shell/batch command script

Alternatively, user can create plain script build step (Execute shell or Execute Windows batch command) and run comments_remover.py Python script manually.

...

If you use Jenkins Struct Plugin, this plugin has a shorthand defined: commentsremover.

For contributors

Updating plugin with a new version of Comments Remover

Create ZIP archive of all files required to run Comments Remover - in particular, comments_remover.py and requirements.txt. Put it in src/main/resources. The plugin expects to find comment_remover.py and requirement.txt on the top lever of the archive.

Debug

mvnDebug hpi:run

You can attach Java Debugger to a local Java process of Jenkins.

Prepare plugin for distribution

mvn package

The *.hpi file will be created in target/ directory. To install manually on local Jenkins, copy it to $JENKINS_HOME/plugins directory.

Releasing new version to Jenkins Update Center

mvn release:prepare release:perform

...

https://wiki.jenkins.io/display/JENKINS/Hosting+Plugins

For contributors

Updating plugin with a new version of Comments Remover

Create ZIP archive of all files required to run Comments Remover - in particular, comments_remover.py and requirements.txt. Put it in src/main/resources. The plugin expects to find comment_remover.py and requirement.txt on the top lever of the archive.

Debug

mvnDebug hpi:run

You can attach Java Debugger to a local Java process of Jenkins.

Prepare plugin for distribution

mvn package

The *.hpi file will be created in target/ directory. To install manually on local Jenkins, copy it to $JENKINS_HOME/plugins directory.

Releasing new version to Jenkins Update Center

mvn release:prepare release:perform

...

https://wiki.jenkins.io/display/JENKINS/Hosting+Plugins

 

For contributors

Updating plugin with a new version of Comments Remover

Create ZIP archive of all files required to run Comments Remover - in particular, comments_remover.py and requirements.txt. Put it in src/main/resources. The plugin expects to find comment_remover.py and requirement.txt on the top lever of the archive.

Debug

mvnDebug hpi:run

You can attach Java Debugger to a local Java process of Jenkins.

Prepare plugin for distribution

mvn package

The *.hpi file will be created in target/ directory. To install manually on local Jenkins, copy it to $JENKINS_HOME/plugins directory.

Releasing new version to Jenkins Update Center

mvn release:prepare release:perform

...