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

Add a changelog, build improvements #227

Merged
merged 3 commits into from
Aug 31, 2023
Merged

Add a changelog, build improvements #227

merged 3 commits into from
Aug 31, 2023

Conversation

wmdietl
Copy link
Member

@wmdietl wmdietl commented Aug 28, 2023

No description provided.

Comment on lines +9 to +11
group 'io.github.eisopux'
version '0.2.0'

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good, will this downloader be used as a dependency in the future?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, do you need to keep all version numbers consistent? Or just different numbers for different repos?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good, will this downloader be used as a dependency in the future?

What do you mean with "this downloader" and "as a dependency"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, do you need to keep all version numbers consistent? Or just different numbers for different repos?

I was thinking whether we should use one version for all three projects, but there is no need to keep them in sync - cf-vscode uses the cf-ls-downloader to download the latest release of eisop/cf and cf-ls. The cf-ls-downloader likely won't need many updates. The cf-ls and the cf-vscode projects hopefully can evolve separately and, ideally, we'll have other IDEs that use the same LSP also. So I think having separate versions is OK.
What do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I agree now. Each extension should have a separate version number for developing. And if we think the downloader is stable, we can make a 1.0.0 release.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good, will this downloader be used as a dependency in the future?

What do you mean with "this downloader" and "as a dependency"?

I am just wondering why adding metadata in the project.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am just wondering why adding metadata in the project.

In general, I would say it's good to put this metadata into your build files.
Here, it results in the built jar file being named ./build/libs/checker-framework-languageserver-downloader-0.3.0-all.jar instead of ./build/libs/checker-framework-languageserver-downloader-all.jar.
So the build artifact also nicely contains the version number.
In the releases, we need to make sure that the first artifact is the built jar file, because that's an assumption of the cf-ls-downloader (we should document that better).
Is there any downside in including this metadata in the build script?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clarification. I looked online, it says this is standard practice when developing libraries or modules intended to be published and shared with other projects. We only need to be mindful when evolving and remember to change it.

CHANGELOG.md Outdated Show resolved Hide resolved
@wmdietl wmdietl merged commit 7f2a7a9 into master Aug 31, 2023
2 checks passed
@wmdietl wmdietl deleted the changelog branch August 31, 2023 20:07
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.

2 participants