{"id":16556,"date":"2012-07-23T13:50:09","date_gmt":"2012-07-23T11:50:09","guid":{"rendered":"https:\/\/mamchenkov.net\/wordpress\/?p=16556"},"modified":"2012-07-23T13:50:09","modified_gmt":"2012-07-23T11:50:09","slug":"semantic-versioning","status":"publish","type":"post","link":"https:\/\/mamchenkov.net\/wordpress\/2012\/07\/23\/semantic-versioning\/","title":{"rendered":"Semantic Versioning"},"content":{"rendered":"\n

A lot of my work these days is all around web projects, where versions aren’t particularly used. \u00a0Code is written, tested, and deployed multiple times a day, rather than once in a while. \u00a0But if you are doing scheduled releases with major and minor changes, backward compatibility and so forth, please consider using Semantic Versioning<\/a>.<\/p>\n

In systems with many dependencies, releasing new package versions can quickly become a nightmare. If the dependency specifications are too tight, you are in danger of version lock (the inability to upgrade a package without having to release new versions of every dependent package). If dependencies are specified too loosely, you will inevitably be bitten by version promiscuity (assuming compatibility with more future versions than is reasonable). Dependency hell is where you are when version lock and\/or version promiscuity prevent you from easily and safely moving your project forward.<\/p>\n

As a solution to this problem, I propose a simple set of rules and requirements that dictate how version numbers are assigned and incremented. For this system to work, you first need to declare a public API. This may consist of documentation or be enforced by the code itself. Regardless, it is important that this API be clear and precise. Once you identify your public API, you communicate changes to it with specific increments to your version number. Consider a version format of X.Y.Z (Major.Minor.Patch). Bug fixes not affecting the API increment the patch version, backwards compatible API additions\/changes increment the minor version, and backwards incompatible API changes increment the major version.<\/p><\/blockquote>\n\n","protected":false},"excerpt":{"rendered":"\n

A lot of my work these days is all around web projects, where versions aren’t particularly used. \u00a0Code is written, tested, and deployed multiple times a day, rather than once in a while. \u00a0But if you are doing scheduled releases with major and minor changes, backward compatibility and so forth, please consider using Semantic Versioning. … Continue reading Semantic Versioning<\/span><\/a><\/p>\n\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false,"_links_to":"","_links_to_target":""},"categories":[1,18,62],"tags":[3069,1588],"keyring_services":[],"class_list":["post-16556","post","type-post","status-publish","format-standard","hentry","category-general","category-programming","category-technology","tag-best-practices","tag-version-control"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t