Skip to content

doc: fix release process doc #133

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 4 commits into from
Mar 3, 2025
Merged

Conversation

okaerin
Copy link
Contributor

@okaerin okaerin commented Feb 26, 2025

Fixes Issue #132

Description

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

@okaerin okaerin marked this pull request as ready for review February 26, 2025 10:12
Copy link
Owner

@jeertmans jeertmans left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! Sorry late review, please see my few comments :)

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

codspeed-hq bot commented Mar 2, 2025

CodSpeed Performance Report

Merging #133 will not alter performance

Comparing okaerin:fix-release-process (dbce34a) with main (204f143)

Summary

✅ 6 untouched benchmarks

@okaerin
Copy link
Contributor Author

okaerin commented Mar 2, 2025

Thanks for the PR! Sorry late review, please see my few comments :)

Thanks for the thorough review. That's ok, we're both doing it for free 😉 . I applied all your comments.

jeertmans
jeertmans previously approved these changes Mar 3, 2025
@jeertmans
Copy link
Owner

Thanks for addressing all my comments! LGTM :-)

@jeertmans jeertmans merged commit 3298c77 into jeertmans:main Mar 3, 2025
14 of 20 checks passed
@jeertmans jeertmans added the documentation Improvements or additions to documentation label Mar 3, 2025
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
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants