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

Use changelist #86

Merged
merged 1 commit into from
Jul 1, 2023
Merged

Use changelist #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ Example `version`

- Update and review `CHANGELOG.md`:

gem install github_changelog_generator
github_changelog_generator -u scientific-python -p spin --since-tag=<last tag>
changelist scientific-python/spin <v0.0> main --version <0.1> >> CHANGELOG.md
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
changelist scientific-python/spin <v0.0> main --version <0.1> >> CHANGELOG.md
changelist scientific-python/spin v0.0 main --version v0.1 > CHANGELOG.md

Not sure if that should be v0.1 or 0.1

Copy link
Member Author

Choose a reason for hiding this comment

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

We can take out the angle brackets indicating what needs to be changed. But we need to leave in the >>.

Copy link
Member Author

Choose a reason for hiding this comment

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

If you take out the angle brackets, we should make it clear that that text needs to be changed in another way. Maybe just explain it in the text below.

Copy link
Member Author

@jarrodmillman jarrodmillman Jul 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

An argument for keeping the angle brackets is that is the standard notation for indicating a manadatory argument that needs to be replaced when used.

Copy link
Member Author

@jarrodmillman jarrodmillman Jul 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe you would prefer

      changelist scientific-python/spin  <last tag> main --version <next version> >> CHANGELOG.md

It is a little long though, but we could remove the explanatory text.

Copy link
Member

Choose a reason for hiding this comment

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

It'd be nice to be able to copy, paste, and modify. The brackets are a bit noisy and hard to read.


where <v0.0> is the last release and <0.1> is the new one.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
where <v0.0> is the last release and <0.1> is the new one.
replacing v0.0 with the previous release and v0.1 is the new one.

Not sure if that should be v0.1 or 0.1?

Copy link
Member Author

Choose a reason for hiding this comment

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

The 0.1 is used in the CHANGELOG and the v0.0 is a tag. We've been prepending v to the release tags, which is pretty common and we should stick with it. I think the release number shouldn't have the v prepended. If it does, then the CHANGELOG will say things like:

We're happy to announce the release of spin v0.1!

I think it looks better the way I had it

We're happy to announce the release of spin 0.1!

Feel free to make a PR to make whatever changes you want. I don't have a strong opinion on this. I will copy your changes to the other sites to keep things consistent.


- Update `version` in `pyproject.toml`.

Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ dependencies = [
spin = "spin.__main__:main"

[project.optional-dependencies]
lint = ["pre-commit >= 3.3"]
lint = ["pre-commit == 3.3"]
dev = ["changelist == 0.1"]

[project.urls]
homepage = "https://github.com/scientific-python/spin"
Expand Down