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 npj Comput Mater citation #77

Merged
merged 5 commits into from
Sep 2, 2024
Merged

Add npj Comput Mater citation #77

merged 5 commits into from
Sep 2, 2024

Conversation

bobleesj
Copy link
Contributor

Followed the citation format from diffpy.structure

Journal abbreviation from

Screenshot 2024-08-30 at 12 56 07 PM

https://doi.org/10.1038/s41524-024-01377-5

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

thanks @bobleesj we just need a news for this.

There is an issue on cookiecutter to add GH actions that check for news so PRs will fail CI if they don't have updated news items, Maybe it is a good time to implelment that. We were going to copy these from the xonsh project on xonsh/xonsh on GH but I think we never did. Let's also add those workflows to existing repos as we remember (i.e., here, now).

@bobleesj
Copy link
Contributor Author

I agree that we need a general CI checking for news items. Will work on it.

@bobleesj
Copy link
Contributor Author

bobleesj commented Sep 1, 2024

Testing 1. Added news called citation.rst

  • As expected, works.
Screenshot 2024-09-01 at 8 50 27 AM

@bobleesj
Copy link
Contributor Author

bobleesj commented Sep 1, 2024

Testing 2. Remove citation.rst

  • Expect to fail

@bobleesj
Copy link
Contributor Author

bobleesj commented Sep 1, 2024

Warning! No news item is found for this PR. If this is an user facing change/feature/fix, please add a news item by copying the format from news/TEMPLATE.rst.

@sbillinge It appears that when no news .rst is found, the CI generates a comment as quoted above instead of failing the CI.

Fail or write comment?

The last part of the script: https://github.com/diffpy/diffpy.snmf/pull/79/files

pr.create_issue_comment(
            """\
**Warning!** No news item is found for this PR. If this is an user facing change/feature/fix,
 please add a news item by copying the format from `news/TEMPLATE.rst`.
"""

Please do not merge yet! Since CI is working as intended, I will make a new PR for bumping Python 3.9 to 3.12

@sbillinge sbillinge merged commit 75334ef into diffpy:main Sep 2, 2024
4 checks passed
@sbillinge
Copy link
Contributor

@bobleesj lovely!

@bobleesj
Copy link
Contributor Author

bobleesj commented Sep 2, 2024

@sbillinge

Fail or write comment?

Please suggest:

When there is no news item, CI does not fail (by design). Instead, it writes a comment.

Would you want me to modify the script so that the CI fails?

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