Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New project name: gradle buildSrcVersions #26

Closed
6 of 8 tasks
jmfayard opened this issue Dec 11, 2018 · 1 comment
Closed
6 of 8 tasks

New project name: gradle buildSrcVersions #26

jmfayard opened this issue Dec 11, 2018 · 1 comment
Labels

Comments

@jmfayard
Copy link
Member

jmfayard commented Dec 11, 2018

Context: buildSrcVersions is a Gradle plugin that makes it easier to manage your dependencies inside your IDE. It extracts all your dependencies and search for available dependencies updates.

I decided I don't want to be stuck with a bad naming for-ever and that I should better do it now than later.

Renaming

Update

Juste update the block: plugins { }

plugins {
  id("de.fayard.buildSrcVersions") version $gradlePluginPortalVersion
  // id("jmfayard.github.io.gradle-kotlin-dsl-libs") version "0.2.6"
}

gradlePluginPortalVersion

Before the renaming

  • The repo will be jmfayard/gradle-kotlin-dsl-libs
  • Install with plugins { id("jmfayard.github.io.gradle-kotlin-dsl-libs") }
  • Run with: $./gradlew syncLibs

Reasons for the change

There are only two hard things in Computer Science:
cache invalidation and naming things.
-- Phil Karlton

  • buildSrcVersions tells what the plugin does: re-generate buildSrc/.../Versions.kt. Neither syncLibs nor gradle-kotlin-dsl-libs does that 😞 .
  • 😞 syncLibs is way too generic.
  • 😞 Libs insists on the wrong thing. Extracting Libs.xxx is done once, searching for new Versions is done many times and is more valuable.
  • 😞 No consistency between syncLibs and gradle-kotlin-dsl-libs.
  • 😞 gradle-kotlin-dsl-libs is not exactly easy to understand and remember. Heck, even I didn't remember it.
  • 😞 It gives the wrong impression that it requires the Kotlin DSL. Something people usually don't know about yet, let alone have upgraded their builds.

TODOs

  • Rename the repo
  • Publishing to the gradlePluginPortal the plugin de.fayard.buildSrcVersions version 0.2.6 New project name: gradle buildSrcVersions #26 #27
  • Thank you. Your new plugin de.fayard.buildSrcVersions has been submitted for approval by Gradle engineers. The request should be processed within the next 24 hours, at which point you will be contacted via email.
  • Redo the README
  • Document how to migrate here and in the CHANGELOG.
  • Edit my previous articles to use the right pluginId.
  • Add a warning in the current version of the plugin to warn of the migration.
  • Do a Github Code search and warn my early adapters of the renaming.
@jmfayard jmfayard changed the title Naming: gradle buildSrcVersions Projet renamed to buildSrcVersions Dec 12, 2018
@jmfayard jmfayard changed the title Projet renamed to buildSrcVersions New project name: gradle buildSrcVersions Dec 12, 2018
jmfayard added a commit that referenced this issue Dec 12, 2018
#26

$ gw :publish
# works locally

$ gw :publishPlugins
> Task :publishPlugins
Publishing plugin de.fayard.buildSrcVersions version 0.2.6
Thank you. Your new plugin de.fayard.buildSrcVersions has been submitted for approval by Gradle engineers. The request should be processed within the next 24 hours, at which point you will be contacted via email.
Publishing artifact build/libs/buildSrcVersions-0.2.6.jar
Publishing artifact build/libs/buildSrcVersions-0.2.6-sources.jar
Publishing artifact build/libs/buildSrcVersions-0.2.6-javadoc.jar
Publishing artifact build/publications/pluginMaven/pom-default.xml
Activating plugin de.fayard.buildSrcVersions version 0.2.6
jmfayard added a commit that referenced this issue Dec 14, 2018
jmfayard added a commit that referenced this issue Dec 16, 2018
New project name: gradle buildSrcVersions #26
jmfayard added a commit to ben-manes/gradle-versions-plugin that referenced this issue Dec 17, 2018
@jmfayard
Copy link
Member Author

all done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant