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

Fix plugin badge showing an outdated version #88

Merged
merged 2 commits into from
Nov 17, 2023
Merged

Conversation

TWiStErRob
Copy link
Contributor

Also would you mind editing 4.0.0 and adding this list item:

  • Dependency coordinates changed from com.github.gmazzo:gradle-buildconfig-plugin to com.github.gmazzo.buildconfig:plugin; Gradle Plugin ID and Marker stayed the same.

@gmazzo
Copy link
Owner

gmazzo commented Nov 17, 2023

Thanks for catching this! I've just updated the URL with the latest shield.io generated code for the badge

@gmazzo gmazzo enabled auto-merge (squash) November 17, 2023 08:50
@gmazzo gmazzo merged commit 9b453b9 into gmazzo:main Nov 17, 2023
2 checks passed
@TWiStErRob TWiStErRob deleted the patch-1 branch November 17, 2023 08:51
@TWiStErRob
Copy link
Contributor Author

You removed the link, it's just an image now.

@gmazzo
Copy link
Owner

gmazzo commented Nov 17, 2023

Yeah, noted that too. I've fixed it already. Thanks!

@TWiStErRob
Copy link
Contributor Author

Nice! What do you think about updating the release notes?

@gmazzo
Copy link
Owner

gmazzo commented Nov 20, 2023

Nice! What do you think about updating the release notes?

Hi, sorry. What is wrong with the release notes? I didn't note anything wrong, but it may be.

I didn't published a new version because there is no change on the code, releases noted including this change will be generated automatically when I release it

@TWiStErRob
Copy link
Contributor Author

I think this should be added to 4.0.0 (mentioned in OP)

  • Dependency coordinates changed from com.github.gmazzo:gradle-buildconfig-plugin to com.github.gmazzo.buildconfig:plugin; Gradle Plugin ID and Marker stayed the same.

Because many users are using the artifacts directly (implementation in buildSrc/includeBuild), and they won't get an update from automated tools, because of not using the marker artifact. When noticing there's a new version (now that the badge shows latest), they'll try to bump the version and fail. Even if they read through the release notes, they won't know that the artifact coordinates changed, unless the above is mentioned. I went through this cycle myself twice already.

@gmazzo
Copy link
Owner

gmazzo commented Nov 20, 2023

Alright, done!

I usually use the <pluginId>:<pluginId>.gradle.plugin convention coordinates for this, that's why I misted. Thanks!

@TWiStErRob
Copy link
Contributor Author

TWiStErRob commented Nov 20, 2023

Thank you!

I know, I do too now, but I only learned about that few months ago even though I've been a fan of Gradle for years. For empirical fun:

  • old plugin artifact 106
  • new plugin artifact 22
  • eternal plugin marker 27

Of course these exclude split/programmatic references like the pattern you had above.

Bonus: I forgot about this, but I noticed while searching. When we use content restricted repositories we have to use both! Example.

I think this is because even the portal is not using the marker: https://plugins.gradle.org/plugin/com.github.gmazzo.buildconfig

@gmazzo
Copy link
Owner

gmazzo commented Nov 21, 2023

Nice, I was not aware how spread this plugin was over the open-source community.

jasonsparc pushed a commit to srskokoro/srskokoro that referenced this pull request Jan 13, 2024
…in case the coordinates change, so as to avoid potential issues like,
gmazzo/gradle-buildconfig-plugin#88 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants