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

Create CompatHelper.yml #96

Merged
merged 1 commit into from
Jul 26, 2022
Merged

Create CompatHelper.yml #96

merged 1 commit into from
Jul 26, 2022

Conversation

jb-mackay
Copy link
Contributor

@jb-mackay jb-mackay commented Jul 21, 2022 •
edited
Loading

PULL REQUEST

Purpose and Content

Add compat entries in Project.toml and CompatHelper workflow to maintain these.

Benefits and Risks

Automates the maintenance of dependency compatibility.

Linked Issues

Addresses #73

PR Checklist

  • This PR has a corresponding issue OR is linked to an SDI.
  • I have followed CliMA's codebase contribution and style guidelines OR N/A.
  • I have followed CliMA's documentation policy.
  • I have checked all issues and PRs and I certify that this PR does not duplicate an open PR.
  • I linted my code on my local machine prior to submission OR N/A.
  • Unit tests are included OR N/A.
  • Code used in an integration test OR N/A.
  • All tests ran successfully on my local machine OR N/A.
  • All classes, modules, and function contain docstrings OR N/A.
  • Documentation has been added/updated OR N/A.

@jb-mackay
Copy link
Contributor Author

jb-mackay commented Jul 21, 2022 •
edited
Loading

Next step is to use CompatDevTools.jl to generate first compat entries.

@jb-mackay jb-mackay self-assigned this Jul 21, 2022
@jb-mackay jb-mackay force-pushed the bm/compathelper branch 2 times, most recently from 78e6d94 to 1891ea5 Compare July 22, 2022 16:53
jb-mackay
jb-mackay commented Jul 22, 2022
View reviewed changes
Project.toml

[compat]
ClimaCore = "0.10"
DocStringExtensions = "0.9"
Copy link
Contributor Author

@jb-mackay jb-mackay Jul 22, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

v0.9 necessary to use @template with parametric types, however Documenter.jl is not compatible with this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This has been resolved as of Documenter v0.27.22

charleskawczynski
charleskawczynski approved these changes Jul 25, 2022
View reviewed changes
Copy link
Member

@charleskawczynski charleskawczynski left a comment

Choose a reason for hiding this comment

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

Code changes look fine to me, can you maybe just comment where the compat yaml was taken from?

@jb-mackay
Copy link
Contributor Author

Code changes look fine to me, can you maybe just comment where the compat yaml was taken from?

CompatHelper.yml copied from CompatHelper.jl

@jb-mackay
Copy link
Contributor Author

bors r+

@bors
Copy link
Contributor

bors bot commented Jul 26, 2022

Build succeeded:

@bors bors bot merged commit 9a81ecc into main Jul 26, 2022
@bors bors bot deleted the bm/compathelper branch July 26, 2022 01:24
@jb-mackay jb-mackay mentioned this pull request Jul 26, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@charleskawczynski charleskawczynski charleskawczynski approved these changes

Assignees

@jb-mackay jb-mackay

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jb-mackay @charleskawczynski