When I publish my artifact (some api jar), how do I specify version ?
is it revision attribute ? I want to have client-lib-1.0.jar
<ivy-module>
<info organisation="the.org" module="client-lib" revision ="1.0">
<info>
</ivy-module>
Firstly, you need to include a publications section, telling ivy what arifacts you are publishing as a module. Ivy is very flexible and quite capable of publishing modules with multiple files and/or types.
<publications>
<artifact name="client-lib" type="jar"/>
<artifact name="client-lib" type="jar" e:classifier="source"/>
<artifact name="client-lib" type="jat" e:classifier="javadocs"/>
</publications>
Secondly (and the answer to your question) the revision number of the published ivy file is decided at publish time. It gets set by the special "pubrevision" attribute of the publish task. Ivy will search the artifact pattern for the file(s) listed in the ivy file to be published.
<ivy:publish resolver="my-deploy" pubrevision="1.0">
<artifacts pattern="${build.dir}/[artifact](-[classifier]).[ext]"/>
</ivy:publish>
Under the hood a new ivy file is being generated and uploaded alongside the module's file.
How the file is stored in the repository is a matter decided by ivy resolver.
An issue you're likely to encounter is that few people host an Ivy repository these days. Instead Maven is the most common standard.
The following detailed detailed example(s) describes how this process works including the messy POM generation stuff (cause Maven doesn't understand ivy files):
how to publish 3rdparty artifacts with ivy and nexus
Convert ivy.xml to pom.xml
Related
My project is build by Ant/Ivy. Ivy is deleting a library (self made) that I need and I don't have a repo for it. How do I configure my ivy that it either doesn't delete files that are not specified OR make a local dependency on the ivy cache?
For Ivy, any dependency has to come from a 'resolver'. So even if you don't have a classical remote repository to host a self made library, you should "publish" that library in a repository.
Ivy is very flexible on how to resolve dependencies in a repository. For a simple adhoc library dependency, you can set a specific folder in your project to be a local repository, and have Ivy resolve dependencies in there.
In your ivysettings.xml, you should then add a resolver for a 'local' folder in which you can put your library:
<ivysettings>
<resolvers>
<filesystem name="local-libs">
<artifact pattern="local/[module]/[artifact].[ext]"/>
</filesystem>
</resolvers>
</ivysettings>
With this piece of settings, considering that in the ivy.xml file of your project you have also declared a dependency on that self made library, Ivy will resolve the dependency tree properly.
More options on a local filesystem resolver can be found in the documentation: https://ant.apache.org/ivy/history/2.5.0/resolver/filesystem.html
I am publishing jar file in nexus using ivy:publish.
My jar file name is shared.project.mainline.jar.
Providing this default pattern
<artifacts pattern="${build.dir}/lib/[artifact].[ext]"/>
But getting below error while publishing
impossible to publish artifacts for shared#project;mainline:
java.io.IOException: missing artifact
shared#project;mainline!project.jar
So how can I change default pattern ?
If running ivy through ant, add " artifactspattern="pattern" " to wherever you are running publish.
If that doesn't work, perhaps it is looking in the right place, but not finding the correct jar.
If so, are you defining the artifact correctly in your ivy file? What does your ivy file look like?
You will want to define the artifact specifically in the ivy file for the module
<artifact *name="artifactname"* type="jar" ext="jar" />
Make sure the name attribute is correctly set
I'm trying to upgrade librarires and artifacts management in my company. Now we're making artifacts (jar, war, ear files) with ant scripts running from Jenkins. I'd like to add Ivy and Artifactory but I'm a little bit unsure what would be best (or at leats good) configuration. As per documentation,
Ivy has three repositories (local, shared and public) and additionaly cache. Reading Artifactory docs, one has to configure Ivy files for Artifactory resolver (not repository?!).
My questions are:
Would that be public repository in Ivy terminology?
Is Ok tu use only one Artifactory repository for development (we have 4 teams) and deployment pipeline?
What would be (approximate) configuration? Is this ok (public ibiblio + enterprise Artifactory)?
<resolvers>
<ibiblio name="libraries" m2compatible="true" />
<url name="arti">
<artifact pattern="http://localhost:8081/artifactory/libs-snapshot-local/[organization]/[module]/[revision]/[artifact]-[revision].[ext]"/>
<ivy pattern="http://localhost:8081/artifactory/libs-snapshot-local/[organization]/[module]/[revision]/ivy-[revision].xml" />
</url>
</resolvers>
Update on 11th Feb:
Just for the record, here is working configuration:
<credentials host="artifactory.host" realm="Artifactory Realm" username="admin" passwd="password"/>
<resolvers>
<chain name="loc-ext">
<filesystem name="tmp-lib">
<artifact pattern="${ivy.settings.dir}/lib/[artifact].[ext]" />
</filesystem>
<ibiblio name="libraries"
m2compatible="true"
checkmodified="true"
root="http://artifactory.host:8081/artifactory/ext-release-local"
/>
</chain>
<ibiblio name="snapshots"
m2compatible="true"
pattern="[organisation]/[module]/[artifact]-[revision].[ext]"
root="http://artifactory.host:8081/artifactory/libs-snapshot-local"
/>
</resolvers>
Chain resolver is for retrieving (f.e. for compiling), tmp_lib has libraries, that are needed only for current task, libraries is sort of enterprise repository and snapshots is for publishing.
We us Artifactory, Jenkins, and Ivy to build most or our projects, but I probably am doing it all wrong.
First, we don't bother with a shared repository. It never made much sense to me. The shared repo looks similar to the private repo, but is shared among developers. What makes that so different from a Artifactory repository that's only shared among the developers?
We also use <ivy:makepom> to create a pom.xml and then use mvn deploy to deploy our artifacts to our Artifactory repo instead of using the <ivy:publish>. We make two poms per jar, one is pom.xml and the other is pom-snapshot.xml. We use Jenkin's Build Promotion Plugin to run mvn deploy with each successful build to deploy the snapshot jar, and then let developers manually "promote a build" via the Build Promotion Plugin to deploy the release version of the jar.
Ivy has the concept of status which looks similar to the snapshot vs. release idea of Maven, but I believe that all these jars with their status are deployed to the same repo. I simply keep the status set to release and depend upon the snapshot/release concept in Maven.
Developers can switch from snapshot versions of a jar to the release version by simply appending or removing -SNAPSHOT from the revision in ivy.xml. This allows developers to use recently built jars without waiting for them to be promoted to the release repository.
My main concern was keeping Artifactory compatible with Maven since some of our projects are Maven projects. Some of this was due to not being 100% familiar with Ivy, and having a firmer grasp with Maven. However, it does work for us and keeps me from worrying about the differences between Ivy and Maven.
Now, that you know we're doing it all wrong, here are the answers to your question:
Would that be public repository in Ivy terminology?
Ivy has the concept of status, but I'm not sure how a Maven project could use that. This is why we use mvn deploy and why we build a snapshot and release pom with each build.
Is Ok tu use only one Artifactory repository for development (we have 4 teams) and deployment pipeline?
Sure, why not? What would be the advantage of making four separate repositories. Besides, even if you go with the separate repositories, you could create them all with a single Artifactory instance. This way, you could assign read/write permissions to each group for each of their repos, but only have to maintain a single Artifactory instance.
What would be (approximate) configuration? Is this ok (public ibiblio + enterprise Artifactory)?
Ours is:
<ivysettings>
<resolvers>
<ibiblio name="public"
m2compatible="true"
checkmodified="true"
root="http://buildl01.tcprod.local/artifactory/libs-release" />
</resolvers>
</ivysettings>
But we're not deploying as Ivy. Just reading from a Maven repo. The libs-release is a virtual repo with includes our local repo and the public repos from Maven, JBoss, and whatever repos we need.
I have a special ivy.dir project that automatically integrates Ivy into our builds. You add in <import file="${ivy.dir}/ivy.tasks.xml"/> into your build, and you automatically have all the necessary Ivy settings. I also create several parallel macros such as` that are drop in replacements with the standard Ant tasks, but do a few mysterious things behind the scenes.
For example <jar.macro> creates a pom.xml, a pom-snapshot.xml, and embeds the Maven info (plus the Jenkins build info) into the jar. This way, developers could start to integrate Ivy into their build process with a minimum of fuss.
I'm learning Ivy (http://ant.apache.org/ivy/) and integrating it as part of our build process. It's going pretty well, but I'm stuck on something with the Ivy publish task. Specifically, I'd like to publish to the local repository with the following pattern (which includes the name of the current configuration):
${ivy.local.default.root}/[organisation]/[module]/[revision]/[type]s/[conf]/[artifact].[ext]
So I set up my custom resolver:
<filesystem name="modifiedLocalRepo">
<ivy pattern="${ivy.local.default.root}/[organisation]/[module]/[revision]/[type]s/[conf]/[artifact].[ext]" />
<artifact pattern="${ivy.local.default.root}/[organisation]/[module]/[revision]/[type]s/[conf]/[artifact].[ext]" />
</filesystem>
And configured the publish task:
<ivy:publish
settingsRef="ivy.ext.settings.custom" <!--Location of definition of modifiedLocalRepo-->
resolver="modifiedLocalRepo"
artifactspattern="bin/Debug/[module].[ext]"
pubrevision="1.1-Test"
overwrite="true"
conf="primary"
/>
And have the conf defined in the ivy.xml file:
<info organisation="Mine" module="Dependency"/>
<configurations defaultconf="primary"> <!--Don't think defaultconf should be necessary-->
<conf name="primary"/>
</configurations>
<publications>
<artifact name="Dependency" ext="dll" type="bin" conf="primary"/>
<artifact name="Dependency" ext="pdb" type="bin" conf="primary"/>
</publications>
I have the process working, ivy configured, resolved, the project building, and the artifacts published (using my custom resolver above). But the [conf] token is always resolving to "default." So the published directory has the structure:
\.ivy2\local\Mine\Dependency\1.1-Test\bins\default\
instead of the structure
\.ivy2\local\Mine\Dependency\1.1-Test\bins\primary\
I've been tinkering around with it, setting the conf value, defaultconf value, etc. everywhere they are valid but it's always "default."
I'm using ant to do the build, and have run in debug mode (-d), inspected the output and noticed nothing useful. I've looked through the output of <echoproperties\> and noticed nothing useful. I've read through the Ivy documentation and only found use of [conf] as a token in retrieve and report output.
I can attach the full xml files I'm using to do my limited test build if it would be useful.
Is the [conf] token valid/respected in the artifact pattern for an Ivy publish? If so, what am I missing? Thanks!
Update:
Was using Ivy 2.3.0-rc2 and decided to try to roll back and use Ivy 2.0.0. Same issue.
Take a look at my Ivy project in github. I set it up, so you can easily add it into an existing Ant project.
We use a Maven repository, so I have it setup to create a pom.xml, and then use mvn deploy:deploy-file to deploy it back to the Maven repository. We use Jenkins for our build, so we use Jenkins to run the mvn deploy-file to do the deployment. I guess we could use <ivy:publish>, but never really tried it.
I have a project that depends upon two jars that are produced by us. I've placed those two jars in our repository, Ivy downloads them, and everything is fine with the compile and building the initial jar.
However, we have another jar that is an obfuscator we need to run against this jar. This is also in our repository, but it isn't needed for the compile. Instead, I simply run it as a program against the freshly built jar.
How should I classify this obfuscation jar's configuration? I can't say it's compile since it's not needed for the compilation. And, it shouldn't be in the runtime configuration either. That leaves us with provided, _optional, _master, or test.
I could create a special configuration for Jars that are required for building the software, but aren't required in the classpath, but I don't want to break our standard and create more than the basic configurations.
What's the best way to handle this?
Ivy configurations are designed to be flexible. Of course it makes perfect sense to standardize on the Maven scopes (especially when pulling from Maven repos) but I see no reason to limit your build, especially for dependencies only used by your build.
I typically create an extra configuration called "build" dedicated to pulling down items like ANT task jars:
<configurations>
<conf name="compile" description="Compile dependencies"/>
<conf name="runtime" description="Runtime dependencies" extends="compile"/>
<conf name="test" description="Test dependencies" extends="runtime"/>
<conf name="provided" description="Dependencies provided by target platform"/>
<conf name="build" description="Dependencies used by ANT build process"/>
</configurations>
If you need this jar only for your build-process an inline retrieve will do the job! It will help you to retrieve artifacts without the need of an ivy file.
This is really useful for jars needed for tasks, that you execute but have nothing to do with the artifact per se (findbugs, etc ..).
<ivy:retrieve organisation="foo" module="bar" inline="true" pattern="${my.install.dir}/[artifact].[ext]"/>
Another alternative is an inline ivy cachepath, where the jar is taken from the cache directly and not retrieved to your project.
<ivy:cachepath
organisation="org" module="module"
revision="latest.integration"
inline="true" pathid="project.compile.sourceprocessing.classpath"/>