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 "Update Gradle Wrapper Action" #7584

Merged
merged 2 commits into from
Mar 29, 2021
Merged

Conversation

koppor
Copy link
Member

@koppor koppor commented Mar 28, 2021

This adds an auto-update for gradle by using https://github.com/gradle-update/update-gradle-wrapper-action.

I quote from the action's manual for the Y:

Why should I use this action?

Gradle Wrapper is the recommended way to setup Gradle in your project. The Wrapper is a script that downloads and invokes a declared Gradle version. By checking the Wrapper into version control you make the build process more standardised, easy and reliable.

Maintaining dependencies up-to-date is regarded as a good practice, and the build system files should be no exception. Unfortunately, often times developers add the Wrapper to the project repository once and just forget about it.

The Update Gradle Wrapper Action aims to help keeping Gradle projects on GitHub polished to high standards and to strengthen the software supply chain in the Gradle ecosystem.
Hygiene

Gradle is under heavy development, with new releases available every few weeks. Projects that stick to old Wrapper versions can't benefit from the tons of features and bug fixes being rolled out.

Updating the build system only once or twice per year might become a tedious task. You will need to walk through longer changelogs and handle any breaking change. Updating frequently helps do less work, take advantage of new features earlier and safely drop deprecated functionality.

This action runs automatically at the declared schedule and creates Pull Requests with detailed information about the version update.

  • Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

@Siedlerchr
Copy link
Member

Maybe combine with the validate gradle workflow

@koppor
Copy link
Member Author

koppor commented Mar 28, 2021

Maybe combine with the validate gradle workflow

The validator runs at each PR and checks whether the wrapper is valid (see

gradlevalidation:
). This PR adds a daily check for an update (similar to dependabot)

@koppor
Copy link
Member Author

koppor commented Mar 28, 2021

Note that I added the label dependencies, which is a consequence of a way to solve the isseu of starting PR checks when the PR is triggered. Details at https://github.com/gradle-update/update-gradle-wrapper-action#running-ci-workflows-in-pull-requests-created-by-the-action.

Copy link
Member

@tobiasdiez tobiasdiez left a comment

Choose a reason for hiding this comment

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

One small comment, otherwise good to go!

.github/workflows/update-gradle-wrapper.yml Outdated Show resolved Hide resolved
.github/workflows/automerge.yml Show resolved Hide resolved
@koppor koppor merged commit ae70c66 into master Mar 29, 2021
@koppor koppor deleted the add-update-gradle-wrapper-action branch March 29, 2021 18:42
Siedlerchr added a commit that referenced this pull request Apr 9, 2021
* upstream/main: (25 commits)
  Fix NumberFormatException in BracketedPattern (#7600)
  Update MAINTAINERS (#7601)
  Fix CSL update (#7592)
  Add unit tests for org.jabref.gui classes (#7579)
  Squashed 'buildres/csl/csl-styles/' changes from 30fb68e..e1acabe
  Bump tika-core from 1.25 to 1.26 (#7589)
  Revert "Skip Mac OS build if secret not present (#7591)" (#7594)
  Optimize saving (#7568)
  Skip Mac OS build if secret not present (#7591)
  Rename master to main in dev help
  Update tests-fetchers.yml
  Update refresh-journal-lists.yml
  Update deployment.yml
  Rename master to main in coding readme
  Rename master to main in citation style update
  Rename master to main in gitversion config
  Fix column sort order gets overwritten (#7573)
  Add some hints on test tooling (#7585)
  Add "Update Gradle Wrapper Action" (#7584)
  Bump classgraph from 4.8.102 to 4.8.104 (#7587)
  ...
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.

3 participants