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

Add a changelog, and back-date some releases #140

Merged
merged 2 commits into from
Aug 27, 2024
Merged

Add a changelog, and back-date some releases #140

merged 2 commits into from
Aug 27, 2024

Conversation

blinry
Copy link
Contributor

@blinry blinry commented Aug 16, 2024

Are we happy with this changelog, @zormit?

Copy link
Contributor

@zormit zormit left a comment

Choose a reason for hiding this comment

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

I checked it and it looks good to me. I've left some ideas for more bullets.

Some potential follow up:

  • Should we make sure that a release exists for each of those tags? It seems that Github allow turning tags into a release.

New features:

- Share multiple files per directory.
- Transmit cursor positions, and display them in the Neovim plugin.
Copy link
Contributor

Choose a reason for hiding this comment

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

Even though not a core feature, we could mention adding a nix flake here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Also it seems we have done some improvements to the daemon-editor protocol specification (it might be good practice to actively mention protocol tweaks and changes in the dev log until we have an actual versioning of that protocol)

See 23246a3

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should we make sure that a release exists for each of those tags?

I think probably not – because we didn't update the version in the Cargo.toml, it will show the wrong version. Except if we start little release branches, and hotfix that there…

I'd be fine with updating the version from now on, when we do the next release! Which could be soon! :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

protocol tweaks and changes

Oh yeah! We dropped the revisioning for the "cursor" messages from the protocol at some point! That's one of the changes I can think of, in addition to supporting JSON-RPC requests now.

- When restarting the daemon, calculate file diffs since the daemon was last online, and apply them to the CRDT.
- Dynamically create files when they are opened.
- When files are deleted, delete them for all peers.
- Sandbox file I/O to be restricted into the shared project folder.
Copy link
Contributor

Choose a reason for hiding this comment

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

The editor plugin can now send JSON-RPC requests and get feedback on whether the intended operation worked or not (#74). Or less "internal": nvim plugin can now process feedback on whether opening a file was successful (#87)

btw, we could also add PRs to this changelog? 🤔 probably overkill to backdate, but going forward... there's probably an app for that? :D (i.e. a tool to scrape our git(hub) log and generate a summary)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

there's probably an app for that

Yeah, like https://github.com/MarcoIeni/release-plz :D (Which follows https://www.conventionalcommits.org/en/v1.0.0/)

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@blinry
Copy link
Contributor Author

blinry commented Aug 27, 2024

Tried adding all your suggestions to the CHANGELOG! :)

@zormit zormit merged commit f8feb33 into main Aug 27, 2024
@zormit zormit deleted the changelog branch August 27, 2024 10:12
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