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

Create CITATION.cff #154

Merged
merged 13 commits into from
Oct 4, 2023
Merged

Create CITATION.cff #154

merged 13 commits into from
Oct 4, 2023

Conversation

rmarow
Copy link
Contributor

@rmarow rmarow commented Oct 3, 2023

related to #151

@rmarow rmarow marked this pull request as ready for review October 3, 2023 19:18
@rmarow rmarow requested a review from MattF-NSIDC October 3, 2023 19:18
@rmarow
Copy link
Contributor Author

rmarow commented Oct 3, 2023

Note: added the badge to the README on the main branch already so that's why it is not in this PR.

@MattF-NSIDC
Copy link

Note: added the badge to the README on the main branch already so that's why it is not in this PR.

@rmarow could you move the badge to the top? See some other projects like QGreenland for examples of how badges are typically displayed.

Copy link

@MattF-NSIDC MattF-NSIDC left a comment

Choose a reason for hiding this comment

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

We need a few changes to ensure this file doesn't have to be manually managed every time we make a release! Otherwise, looks great, nice work :)

CITATION.cff Outdated Show resolved Hide resolved
CITATION.cff Show resolved Hide resolved
pyproject.toml Outdated
Comment on lines 59 to 70
parse = """
(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)
(?:
(?P<prerelease>alpha|beta|rc)
(?P<build>\\d+)
)?
$
"""
serialize = [
"{major}.{minor}.{patch}{prerelease}{build}",
"{major}.{minor}.{patch}",
]
Copy link

@MattF-NSIDC MattF-NSIDC Oct 3, 2023

Choose a reason for hiding this comment

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

We can get rid of the parse and serialize sections and just use the default behavior. We don't need to think about "alpha" or "beta" or "rc", at least not yet.

Choose a reason for hiding this comment

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

And can get rid of [tool.bumpversion.parts.prerelease] and [tool.bumpversion.parts.build] sections

@rmarow rmarow marked this pull request as draft October 3, 2023 22:24
@rmarow
Copy link
Contributor Author

rmarow commented Oct 3, 2023

usage: bumpversion [-h] [--config-file FILE] [--verbose] [--list] [--allow-dirty] [--parse REGEX]
                   [--serialize FORMAT] [--search SEARCH] [--replace REPLACE] [--current-version VERSION]
                   [--no-configured-files] [--dry-run] --new-version VERSION [--commit | --no-commit]
                   [--tag | --no-tag] [--sign-tags | --no-sign-tags] [--tag-name TAG_NAME]
                   [--tag-message TAG_MESSAGE] [--message COMMIT_MSG] [--commit-args COMMIT_ARGS]
                   part [file ...]
bumpversion: error: the following arguments are required: --new-version
(usaon-vta-survey) (2) roma8902@cu-vpn-nsidc-172:~/projects/usaon-vta-survey
$ bumpversion minor --allow-dirty --new-version 0.6.0
Traceback (most recent call last):
  File "/Users/roma8902/mambaforge/envs/usaon-vta-survey/bin/bumpversion", line 10, in <module>
    sys.exit(main())
  File "/Users/roma8902/mambaforge/envs/usaon-vta-survey/lib/python3.10/site-packages/bumpversion/cli.py", line 135, in main
    context = _commit_to_vcs(files, context, config_file, config_file_exists, vcs,
  File "/Users/roma8902/mambaforge/envs/usaon-vta-survey/lib/python3.10/site-packages/bumpversion/cli.py", line 693, in _commit_to_vcs
    context.update({'current_' + part: current_version[part].value for part in current_version})
TypeError: 'NoneType' object is not iterable

Running into this while testing the new bump-my-version config. Haven't had much of a chance to look into it yet.

@MattF-NSIDC
Copy link

You shouldn't need to pass both a "part" and a --never-version value, should be one or the other. The error message is not great... This would be a useful bug to report on the bump-my-version GitHub project! Maybe the program should detect this case and fail early with a better message?

@rmarow rmarow marked this pull request as ready for review October 4, 2023 15:38
@rmarow rmarow requested a review from MattF-NSIDC October 4, 2023 15:38
@rmarow rmarow merged commit d473914 into main Oct 4, 2023
2 checks passed
@rmarow rmarow deleted the citation-cff branch October 4, 2023 20:23
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