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.

Sign up for GitHub

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

Jump to bottom

[#1927] Increase minimum version required for Git #2028

Merged
merged 7 commits into from
Aug 19, 2023
Merged

[#1927] Increase minimum version required for Git #2028

merged 7 commits into from
Aug 19, 2023

Conversation

jq1836
Copy link
Contributor

@jq1836 jq1836 commented Aug 15, 2023 •
edited
Loading

Fixes #1927

Proposed commit message

Currently, RepoSense requires a minimum Git version of 2.14, with an
additional requirement of version 2.23 for the --find-previous-authors
flag. Supporting Git version 2.14 while requiring Git version 2.23 for
certain features adds complexity in the form of a Git version checker
to disable features depending on Git version 2.23.

Let's increase the minimum Git version required from 2.14 to 2.23.

Other information

Changes:

  • Removed GitVersion class.
  • Updated UG and DG to reflect the increase in Git version required.
  • Removed tests related to Git version.
  • Removed messages related to Git version.

Notes:
RepoSense will still run perfectly fine with Git version 2.14 - 2.22 provided that the user does not use the --find-previous-authors flag in the CLI or have the Find Previous Authors column in repo-config.csv set to yes. Doing otherwise would result in the program failing.

MarcusTXK
MarcusTXK requested changes Aug 17, 2023
View reviewed changes
Copy link
Member

@MarcusTXK MarcusTXK left a comment

Choose a reason for hiding this comment

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

Great job! I think this is very well done, nice that you updated the relevant documentation as well.

Just one minor nitpick is that you missed out deleting a now unused variable GIT_VERSION_INSUFFICIENT_MESSAGE, located in java/reposense/ConfigSystemTest.java. Once that is cleaned up, this will be good to merge.

@jq1836
Copy link
Contributor Author

jq1836 commented Aug 17, 2023

Thanks for the review. Have made the relevant changes and am ready for review again.

@jq1836 jq1836 requested a review from MarcusTXK August 17, 2023 03:28
MarcusTXK
MarcusTXK approved these changes Aug 17, 2023
View reviewed changes
Copy link
Member

@MarcusTXK MarcusTXK left a comment

Choose a reason for hiding this comment

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

LGTM, nice job!

@MarcusTXK MarcusTXK requested a review from a team August 17, 2023 04:23
@MarcusTXK MarcusTXK requested a review from a team August 17, 2023 05:55
chan-j-d
chan-j-d requested changes Aug 19, 2023
View reviewed changes
Copy link
Contributor

@chan-j-d chan-j-d left a comment

Choose a reason for hiding this comment

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

Thanks for doing this up. Wanted to request some small changes regarding the specification of 2.23 in UG

docs/ug/cli.md Outdated
Comment on lines 87 to 91
<box type="info" seamless>

* This flag only works on **git `2.23`** or later.
* If an earlier version of **git** is used, RepoSense can still run but this flag will be ignored.
* If an earlier version of **git** is used, RepoSense can still run but only if this flag is not used.
</box>
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe we can remove this section since we are assuming version 2.23.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for pointing this out, will make the changes accordingly.

docs/ug/configFiles.md Outdated
Comment on lines 49 to 52
<box type="info" seamless>
The Find Previous Authors option only works on **git `2.23`** or later.
</box>

Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment with this part

@jq1836 jq1836 requested a review from chan-j-d August 19, 2023 06:54
chan-j-d
chan-j-d approved these changes Aug 19, 2023
View reviewed changes
Copy link
Contributor

@chan-j-d chan-j-d left a comment

Choose a reason for hiding this comment

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

LGTM!

@chan-j-d chan-j-d merged commit a537db6 into reposense:master Aug 19, 2023
10 checks passed
@github-actions
Copy link
Contributor

The following links are for previewing this pull request:

@jq1836 jq1836 deleted the 1927-increase-min-git-version branch August 19, 2023 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MarcusTXK MarcusTXK MarcusTXK approved these changes

@sikai00 sikai00 sikai00 approved these changes

@chan-j-d chan-j-d chan-j-d approved these changes

Assignees
No one assigned
Labels
s.ToReview
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Increase minimum version required for Git
4 participants
@jq1836 @MarcusTXK @sikai00 @chan-j-d