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

Better document the changes users might see. #384

Merged
merged 1 commit into from
Jan 18, 2023

Conversation

ltratt
Copy link
Member

@ltratt ltratt commented Jan 18, 2023

I (re)migrated a project using grmtools-0.12 to see what breaks and realised that we'd missed some things out in CHANGES.md. This commit adds in all the things that I know users will encounter (there might be others, but hopefully not!).

@ratmice I'm starting to think that we're also getting to the right point to make a 0.13 release. Are there any other parts of the API that you can see should be considered for change before we do so?

I (re)migrated a project using grmtools-0.12 to see what breaks and
realised that we'd missed some things out in `CHANGES.md`. This commit
adds in all the things that I know users will encounter (there might be
others, but hopefully not!).
@ratmice
Copy link
Collaborator

ratmice commented Jan 18, 2023

All good catches, in updating my own projects and various random downstream projects, I've only run into 2 of these 3 cases listed as major changes. (The escaping one which is there already and the unused token/rule case here). Sorry I have been a little lackadaisical about keeping the CHANGES.md file up to date as we land these changes.

bors r+

@bors
Copy link
Contributor

bors bot commented Jan 18, 2023

Build succeeded:

@bors bors bot merged commit dd25f16 into softdevteam:master Jan 18, 2023
@ratmice
Copy link
Collaborator

ratmice commented Jan 18, 2023

@ratmice I'm starting to think that we're also getting to the right point to make a 0.13 release. Are there any other parts of the API that you can see should be considered for change before we do so?

Forgot to respond to this. There isn't anything critical, I had looked at #349 and it is going to take some thinking since it delays the time at which we may first have a YaccGrammarKind until much later than we currently do, and there are various assumptions that we have one. That being such a larger change relative to the minor enhancement it provides I don't think it may not be worth delaying, or trying to rush getting that in the release.

@ltratt ltratt deleted the more_changes branch January 18, 2023 10:38
@ltratt
Copy link
Member Author

ltratt commented Jan 18, 2023

Hmm, yes, #349 might not be worth waiting for. OK, my plan is to make a 0.13 release tomorrow PM GMT/UTC, unless anyone thinks of something that should cause us to pause.

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