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 citation file and validating GHA #5483

Merged
merged 9 commits into from
Dec 22, 2023

Conversation

HGWright
Copy link
Contributor

@HGWright HGWright commented Sep 7, 2023

🚀 Pull Request

Description

This adds a CITATION.cff file and a GitHub Action to validate the CITATION.cff file.

I messed up the rebase somehow on #5161 and not the PR is very polluted, so I have remade the changes here and will capture the conversation that took place there at the bottom of this.

@bjlittle I have added you as the reviewer as you were also the reviewer for the previous PR.

I am also linking to #5453 and #4679 as they were mentioned in the original PR.

Closes #5118


The original PR comment:

image

Suggestion to add GHA:

image

Original review comments:

image

The comments that lead to the current approach:

image

@codecov
Copy link

codecov bot commented Sep 7, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9d83811) 89.69% compared to head (f611082) 89.69%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5483   +/-   ##
=======================================
  Coverage   89.69%   89.69%           
=======================================
  Files          90       90           
  Lines       22807    22807           
  Branches     5441     5441           
=======================================
  Hits        20456    20456           
  Misses       1618     1618           
  Partials      733      733           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pp-mo
Copy link
Member

pp-mo commented Nov 9, 2023

Not sure if this helps, but I just stumbled on some advice elsewhere, which seems to suggest it's really easy to automate this for each release.

I'm not confident that I personally understand the issues here. But, might this be helpful ??

@trexfeathers trexfeathers self-assigned this Dec 14, 2023
@trexfeathers trexfeathers self-requested a review December 14, 2023 11:11
Copy link
Contributor

@trexfeathers trexfeathers 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 your patience, @HGWright! Here is your long-awaited review

.github/workflows/ci-citation Outdated Show resolved Hide resolved
.github/workflows/ci-citation Outdated Show resolved Hide resolved
CITATION.cff Outdated Show resolved Hide resolved
CITATION.cff Show resolved Hide resolved
CITATION.cff Show resolved Hide resolved
CITATION.cff Show resolved Hide resolved
CITATION.cff Outdated Show resolved Hide resolved
CITATION.cff Show resolved Hide resolved
CITATION.cff Show resolved Hide resolved
docs/src/whatsnew/latest.rst Outdated Show resolved Hide resolved
docs/src/userguide/citation.rst Outdated Show resolved Hide resolved
docs/src/userguide/citation.rst Outdated Show resolved Hide resolved
docs/src/userguide/citation.rst Outdated Show resolved Hide resolved
docs/src/userguide/citation.rst Outdated Show resolved Hide resolved
docs/src/userguide/citation.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

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

Super, LGTM!

@trexfeathers trexfeathers merged commit 8342121 into SciTools:main Dec 22, 2023
18 checks passed
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.

Add a citation file
3 participants