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

[INFRA] add citation cff and validation workflow #135

Merged
merged 5 commits into from
Jun 27, 2023
Merged

[INFRA] add citation cff and validation workflow #135

merged 5 commits into from
Jun 27, 2023

Conversation

Remi-Gau
Copy link
Contributor

@Remi-Gau Remi-Gau commented Jun 27, 2023 •
edited
Loading

Relates to #76

Changes proposed in this pull request:

  • add a citation file and a workflow to validate it

Checklist

  • PR has an interpretable title with a prefix ([ENH], [BUG], [DOC], [INFRA], [MAINT])
  • PR links to Github issue with mention Closes #XXXX
  • Tests pass
  • Code is properly formatted

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

@coveralls
Copy link
Collaborator

coveralls commented Jun 27, 2023 •
edited
Loading

Pull Request Test Coverage Report for Build 5393233099

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%
Totals Coverage Status
Change from base Build 5346954902: 0.0%
Covered Lines: 158
Relevant Lines: 158
💛 - Coveralls

Remi-Gau
Remi-Gau commented Jun 27, 2023
View reviewed changes
CITATION.cff
email: [email protected]
family-names: Bhagwat
given-names: Nikhil
orcid: "https://orcid.org/0000-0001-6073-7141"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jarmoza @jarmoza @alyssadai @surchs
you can add your ORCID if you want

Remi-Gau
Remi-Gau commented Jun 27, 2023
View reviewed changes
CITATION.cff

title: "neurobagel_api"

version: 0.2.0
Copy link
Contributor Author

Choose a reason for hiding this comment

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

the issue was talking about version 0.2.0 so I went with this.

Copy link
Contributor

Choose a reason for hiding this comment

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

@alyssadai if you want to release as 0.1.0, please adjust this line accordingly

surchs
surchs approved these changes Jun 27, 2023
View reviewed changes
Copy link
Contributor

@surchs surchs left a comment

Choose a reason for hiding this comment

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

Thanks a lot @Remi-Gau for getting us started on this. This is good to go 🧑‍🍳 I'll merge it for you!

.github/workflows/cff_validation.yml

on:
push:
branches: ['*']
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can probably just run this against main since we know what our branches are called.

@surchs surchs merged commit 86bea64 into neurobagel:main Jun 27, 2023
3 checks passed
@surchs surchs mentioned this pull request Jun 27, 2023
Merged
4 tasks
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@surchs surchs surchs approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Neurobagel
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Remi-Gau @coveralls @surchs @alyssadai @jarmoza