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

Readme update #197

Merged
merged 3 commits into from
Dec 30, 2023
Merged

Readme update #197

merged 3 commits into from
Dec 30, 2023

Conversation

eliotwrobson
Copy link
Collaborator

@eliotwrobson eliotwrobson commented Dec 30, 2023

See title, updates readme links to new documentation.

Also, removed the publish trigger for pushes to the develop branch. Once this is merged, all that's needed should be a merge to master! @caleb531 once that's done, I can open the submission.

@coveralls
Copy link

coveralls commented Dec 30, 2023

Coverage Status

coverage: 99.64%. remained the same
when pulling 81d1a23 on eliotwrobson:new_links
into deea457 on caleb531:develop.

Copy link
Owner

@caleb531 caleb531 left a comment

Choose a reason for hiding this comment

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

@eliotwrobson Yep, looks good to me! Although from a philosophical perspective, I'm trying to figure out how I feel about merging to main without actually publishing a release. Because that would mean that main is no longer reflecting the latest published release, but rather, something in-development.

Maybe since we won't have published the tag yet, it won't matter? I suppose we could publish v9.0.0, but I think I would prefer to launch the docs site with the v9 for promotional purposes.

What are your thoughts?

@eliotwrobson
Copy link
Collaborator Author

@caleb531 I think that merging and then doing a v9 release for promotional purposes is fine (or even an 8.2). The only thing to note is that we'll probably have to do a release once the review is done, but I don't really mind multiple releases.

If you want to bundle the site with a v9 release, I'd say go ahead! The release notes should be minimal. Either way, I'd like to get the review started today, and we need the new links in the readme merged to main before we can get that going. I'll also go ahead and merge this PR.

@eliotwrobson eliotwrobson merged commit 20d8233 into caleb531:develop Dec 30, 2023
7 checks passed
@caleb531
Copy link
Owner

caleb531 commented Dec 31, 2023

@eliotwrobson Now that I think of it, do we even have any breaking changes to warrant a v9 release? Here are all the commits/merges on develop that have not yet been merged to main:

I suppose the only changes of substance are the show_diagram method for PDAs and the regex quantifier fix, but besides that, it's all housekeeping.

I've created a draft v8.2.0 GitHub release for you to look at—if you approve, I can go ahead and publish a v8.2.0 release!

@eliotwrobson
Copy link
Collaborator Author

@caleb531 I had the same thought, I didn't think there were any breaking changes that really necessitated a v9 release. I think the notes look good and I approve! Once the release publishes, I'll cc you on the submission later today.

@caleb531
Copy link
Owner

@eliotwrobson Excellent! I just published v8.2.0, and it's live now!:

https://github.com/caleb531/automata/releases/tag/v8.2.0
https://pypi.org/project/automata-lib/

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.

3 participants