Artifactory User Plugins

Note: JFrog Workers is the recommended cloud-native solution for extending the JFrog Platform (including Artifactory). While user plugins are still supported, we recommend using JFrog Workers where possible for better scalability, security, and performance. Learn more about JFrog Workers.

Upgrade Notice

1. Groovy 4 Upgrade: Artifactory is upgraded to Groovy 4 in version 7.101.0 (released on 25th Nov 2024 for cloud), which leads user plugins compatible with groovy 4. The promotion plugin has been updated for compatibility with Groovy 4. This upgrade may affect existing user plugins, so ensure you test your plugins after upgrading.

   • Branch Compatibility:
     • master: Artifactory 7.101.0 & above

       Note: Groovy 3 no longer supported on master branch

     • artifactory-groovy-3: Artifactory 7.100.0 & below

2. JDK17 Compatibility: With the introduction of JDK17 support in Artifactory version 7.43 and above, many older user plugins may no longer be compatible. Deprecated plugins are now moved to the deprecated directory.

Please consider migrating to JFrog Workers for cloud-native and future-proof solutions.

Documentation References

• Artifactory Documentation: Official documentation for Artifactory features, setup, and configuration.
• User Plugin Documentation: Guide to writing and using custom Artifactory plugins.
• JFrog Workers Documentation: Learn more about JFrog Workers for extending Artifactory in a cloud-native way.

Worker Alternatives for Plugins

JFrog Workers are supported only for Enterprise X and Plus licenses. Workers offer an alternative to Artifactory user plugins, enabling you to extend the JFrog Platform using cloud-native, scalable, and secure solutions.

The following are the Worker alternatives for Artifactory plugins:

User Plugins	Worker Alternative
artifactCleanup	ArtifactCleanup Worker
backUpFolder	X
promotions	X
checksums	X
cleanDockerImages	cleanDockerImages Worker
deleteByPropertyValue	deleteByPropertyValue Worker
deleteDeprecatedPlugin	X
deleteEmptyDirsPlugin	deleteEmptyDirsWorker
mavenSnapshotCleanupWhenRelease	X
cleanOldBuilds	X
remoteBackup	remoteBackup Worker
repoQuota	repoQuota Worker
restrictOverwrite	restrictOverwrite Worker
repoStats	repoStats Worker
preventUnapproved	preventUnapproved
getP2Urls	X
getPropertySetsList	X
getProxiesList	X
getLayoutsList	X
webhook	X

Note: For some user plugins, there is no direct worker sample available. You may need to adapt or refactor existing functionality using workers, depending on your specific use case.

Contributing to Artifactory User Plugins

Although JFrog Workers is the preferred approach, we still accept contributions for Artifactory user plugins, particularly for those who cannot migrate to JFrog Workers at the moment. Contributions should follow the guidelines specified in the CONTRIBUTING.md file.

To maintain a consistent and high-quality codebase, we encourage contributions to:

• Fixing bugs or security issues
• Refactoring existing functionality for better compatibility with newer Artifactory versions

Migrating from User Plugins to JFrog Workers

If you are planning to migrate from Artifactory user plugins to JFrog Workers, follow the steps below:

1. Evaluate: Check the list of existing user plugins and identify the functionalities that need to be migrated.
2. Explore Worker Samples: Review existing worker samples to understand how workers can replace your current plugin logic.
3. Refactor and Deploy: Migrate the logic to a JFrog Worker and test it in your development or staging environment.
4. Monitor and Optimize: Once the worker is running in production, monitor its performance and optimize as needed.

Migrating to JFrog Workers allows you to leverage the benefits of cloud-native architecture, including scalability, improved security, and better maintenance.

Additional Resources

• Artifactory REST API: API documentation
• JFrog Community Support: For troubleshooting, feature requests, or to engage with other developers using Artifactory and JFrog Workers, visit JFrog Community.

License & Copyright

Copyright © 2024, JFrog Ltd.

This project is licensed under the terms of the Apache 2.0 License, to learn more, refer to LICENSE.