Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Next »

What does this do?


This plugin performs subversion tagging (technically speaking svn copy) on successful build. This is useful when you want to access the stable codebase.


How tagging works?

  1. Read Subversion authentication information from Hudson's Subversion SCM configuration.
  2. Delete the existing tag if exists.
  3. Perform URL to URL svn copy.

Please note that svn copy is cheap because it doesn't duplicate file contents when not necessary. URL to URL copy is also fast because there is no data transfer from Hudson to Subversion, unlike maven scm plugin's "tag" goal.
The tag base URL must be created in advance.

Configuration

Subversion Authentication


When you specify subversion repo URL, you are requested to enter authentication information. The values are stored in hudson.scm.SubversionSCM.xml in HUDSON_HOME directory. This plugin obtains the authentication information directly from Hudson core's Subversion SCM class so the principal and credential specified here is used for subversion authentication.

System configuration


The default tag base URL and the template of tag comment can be specified. Those values are automatically populated when this plugin is enabled in the job's configuration.

  • Base tag URL's hostname must be identical with the one of Subversion URL. Different notation (e.g. raw IP address and hostname, short hostname and fully qualified hostname, or using alias) is recognized as different servers so that please make sure to use the identical hostname.

    Job name in tag base URL

    Job name is no longer implicitly appended to tag base URL since version 1.2. Please use '${env['JOB_NAME']}' if you need to use job name as a part of tag URL.

  • Relative URL is accepted since version 1.5. It is resolved by Subversion repository URL. This is useful when you specify multiple locations with uniformed hierarchy.
    myRepo/
    |-- project1
    |   |-- branches
    |   |-- tags
    |   `-- trunk
    |       `-- subproject1
    `-- project2
        |-- branches
        |-- tags
        `-- trunk
            |-- subproject2
    

    Suppose http://svn.example.com/svn/myRepo/project1/trunk/subproject1 and http://svn.example.com/svn/myRepo/project2/trunk/subproject2 are specified as svn locations. Specifying ../tags/${env['JOB_NAME']} instead of an absolute tag base URL results in creation of tag http://svn.example.com/svn/myRepo/project1/tags/job_name and http://svn.example.com/svn/myRepo/project2/tags/job_name.

  • The location URL path list delimited by "/" (slash) is bound to groovy runtime as "repoURL" since version 1.6. Any path can be embedded as a part of tag base URL. Suppose you have the following hierarchy.
    svnrepo/
    |-- branches
    |-- tags
    `-- trunk
        |-- project1
        |   |-- a.txt
        |   |-- subproject1
        |   |   `-- subproject1.txt
        |   `-- subproject2
        |       `-- subproject2.txt
        `-- project2
            |-- subproject21
            |   `-- subproject21.txt
            `-- subproject22
                `-- subproject22.txt
    
    You specify two locations in subversion configuration.
    location 1: http://svn.example.com/svn/svnrepo/trunk/project1
    location 2: http://svn.example.com/svn/svnrepo/trunk/project2
    
    Then specify the tag base URL embedding a part of repoURL as tag base URL.
    http://svn.example.com/svn/svnrepo/tags/${env['BUILD_TAG']}/${repoURL[-1]}
    (or)
    ../tags/${env['BUILD_TAG']}/${repoURL[-1]}
    

    You will the following tags. Please note that repoURL contains [http,svn.example.com,svn,svnrepo,trunk,project1] as List, and groovy allows to access the element from the end by specifying negative index. For example, repoURL[-2] returns trunk as the value.

    svnrepo/
    |-- branches
    |-- tags
        |-- hudson-svnrepo-3
        |   |   |-- project1
        |   |   |   |-- a.txt
        |   |   |   |-- subproject1
        |   |   |   |   `-- subproject1.txt
        |   |   |   `-- subproject2
        |   |   |       `-- subproject2.txt
        |   |   `-- project2
        |   |       |-- subproject21
        |   |       |   `-- subproject21.txt
        |   |       `-- subproject22
        |   |           `-- subproject22.txt
    
  • The template of comment recognizes groovy syntax. Map returned from hudson.model.AbsutractBuild#getEnvVars() and System Properties are bound so that you can refer them as env and sys respectively.
  • The value of Map (and Properties) can be refered like this.
    Build: ${env['BUILD_TAG']} on OS ${sys['os.name']} ${sys['os.version']}.
    
  • Compilation happens when the focus is moved from the text field. Please check if the quotes, braces, and brackets are balanced when you get a compilation error. A closing single quote is missing after BUILD_TAG in the case below.

Job configuration

You can customize the tag base URL and comment specific for the job. The default values specified at System configuration is populated as the default values when the plugin is enabled.

Known limitations

  • Any authentication method supported by Hudson Subversion core (SubversionSCM.class) should work from v1.4, but haven't tested. Please send a mail to kenjin at clazzsoft dot com if you successfully tag with the authentication methods other than username / password. Please contact me if you have problems with other authentication scheme.
  • Tagging for the project with multiple locations that are not symmetric and needed to be tagged in the different depth are not supported yet. This should be able to be addressed by specifying tag base URL per location, but haven't implemented yet.

History

04/17/08 Version 1.0

  • Initial checkin.

04/18/08 Version 1.1

  • Fixed a path issue in help html links.

05/11/08 Version 1.2

  • Added groovy expression support in tag base URL.

    Change in tag base URL

    The tag base URL no longer appends job name implicitly at the end since this version. Please add '${env['JOB_NAME']}' if you upgrade from version 1.1 and want to keep the original behavior.

07/20/08 Version 1.3

  • Added the support for multiple subversion repositories.

07/31/08 Version 1.4

  • Got rid of parsing hudson.scm.SubversionSCM.xml and obtained SVN authentication information directly from SubversionSCM class.

08/09/08 Version 1.5

  • Added the support for relative tag base URL.

08/12/08 Version 1.6

  • Added "repoURL" binding to tag base URL groovy expression so that a part of repoURL can be embedded in tag base URL.
  • No labels