Move ast and specification release notes into separate directories #519
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mbhealy
requested review from
hodgestar,
blakejohnson,
braised-babbage and
levbishop
hodgestar
reviewed
Mar 20, 2024
…the ast/spec reports
…h release notes getting updated
…em with release notes
|
I have an example version of a publishable build using this branch available at https://mbhealy.github.io/ currently. The release notes in the 3.0 and 3.1 versions don't contain anything currently because we would need to backport this PR there first. |
hodgestar
approved these changes
Apr 17, 2024
braised-babbage
approved these changes
Apr 30, 2024
There was a problem hiding this comment.
Looks good to me. Not really an issue for this PR but I wondered if things might be clearer if we move the code for the Python package out from the current source directory (which contains the spec and .rst files). In a world where we had something like two disjoint directories
spec/
ast/
then e.g. we could have release notes for each stored in these. There is a common dependence on the ANTLR grammar, so that would have to be sorted out.
blakejohnson
approved these changes
May 6, 2024
|
Ok to merge, I assume? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This is the second of two options for handling separate AST/grammar and specification release notes using reno. The first is #518 .
Details and comments
In this version I have created new directories
spec_releasenotesandast_releasenotesand separated the existing notes between the two. I have also updated the contributing guidelines appropriately and the script that checks that a reno note has been created whenever there are changes in the source directory.