Skip to content

chore(ci): add cargo release functionality #130

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

Merged
merged 5 commits into from
Feb 25, 2025

Conversation

okaerin
Copy link
Contributor

@okaerin okaerin commented Feb 22, 2025

Closes #122

Description

Change Unreleased to released and prepare a new Unreleased section.

Check List (Check all the applicable boxes)

  • I understand that my contributions needs to pass the checks.
  • If I created new functions / methods, I documented them and add type hints.
  • If I modified already existing code, I updated the documentation accordingly.
  • The title of my pull request is a short description of the requested changes.

Screenshots

Note to reviewers

Copy link

codspeed-hq bot commented Feb 22, 2025

CodSpeed Performance Report

Merging #130 will not alter performance

Comparing okaerin:cargo-release (8ead32c) with main (3dfcc9a)

Summary

✅ 6 untouched benchmarks

@okaerin
Copy link
Contributor Author

okaerin commented Feb 22, 2025

Hi @jeertmans as the rustfmt failure stems from the pull request #129 should I fix it here or create a separate one? And on the other hand is it how you imagined that the issue would be solved?

@jeertmans
Copy link
Owner

Hi @okaerin, thanks for your contribution!

Hi @jeertmans as the rustfmt failure stems from the pull request #129 should I fix it here or create a separate one? And on the other hand is it how you imagined that the issue would be solved?

No, #117 will address that, don't worry ;-)

Could you please document the installation / need of cargo-release?

E.g., there could be a RELEASE-PROCESS.md file that explains how to install cargo-release and how to use it to properly release a new version. I think I did this for another repo I maintain, see https://github.com/maciejhirsz/logos/blob/master/RELEASE-PROCESS.md

@jeertmans jeertmans added the ci Continuous Integration related (GitHub actions, precommit, …) label Feb 24, 2025
@okaerin
Copy link
Contributor Author

okaerin commented Feb 24, 2025

Hi @okaerin, thanks for your contribution!

Hi @jeertmans as the rustfmt failure stems from the pull request #129 should I fix it here or create a separate one? And on the other hand is it how you imagined that the issue would be solved?

No, #117 will address that, don't worry ;-)

Could you please document the installation / need of cargo-release?

E.g., there could be a RELEASE-PROCESS.md file that explains how to install cargo-release and how to use it to properly release a new version. I think I did this for another repo I maintain, see https://github.com/maciejhirsz/logos/blob/master/RELEASE-PROCESS.md

I used the RELEASE-PROCESS.md as guidance, thanks. Any chance that we could bump the version of languagetool-rust to 2.1.5? Of course I could prepare a PR after this one.

@jeertmans
Copy link
Owner

Thanks for your contribution!

I used the RELEASE-PROCESS.md as guidance, thanks. Any chance that we could bump the version of languagetool-rust to 2.1.5? Of course I could prepare a PR after this one.

Yes, please do that in another PR :-)

@jeertmans jeertmans merged commit 204f143 into jeertmans:main Feb 25, 2025
16 of 21 checks passed
@okaerin okaerin deleted the cargo-release branch February 25, 2025 10:28
jeertmans added a commit that referenced this pull request Mar 11, 2025
* fix(lib): use `.form` instead of `.query` when relevant and added `Accept: application/json` header (#129)

* fix query to form encoded payload

* change all requests to form encoded

* add accept header "application/json"

* revert /words to query encoded

* update changelog

* chore(ci): add cargo release functionality (#130)

* rename unrelease

* prepare next unreleased section

* add release process and changelog update

* add cargo release install cmd

* omit workspace

* fix(docs): release process doc (#133)

* fix doc

* update changelog

* apply review comments

- clarified purpose of cargo release
- simplified release preparation (removed parameters are in Cargo.toml)

* Update RELEASE-PROCESS.md

---------

Co-authored-by: Jérome Eertmans <jeertmans@icloud.com>

* Update CHANGELOG.md

* Update CHANGELOG.md

---------

Co-authored-by: Andreas Huber <43344129+okaerin@users.noreply.github.com>
Co-authored-by: Jérome Eertmans <jeertmans@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration related (GitHub actions, precommit, …)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CHORE] Setup cargo-release for automatic bump
2 participants