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.

Sign up for GitHub

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

Update README: add maintained badge, release procedure #192

Merged
merged 2 commits into from
Aug 26, 2024
Merged

Update README: add maintained badge, release procedure #192

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94e3cfc
Update README: add maintained badge, release procedure
strohel Aug 23, 2024
ec7820a
Refine release procedure
Y-Nak Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

[![Crates.io][crates-badge]][crates-url]
[![Documentation][docs-badge]][docs-url]
[![MPL-2.0][mpl-badge]][mpl-url]
[![Build Status][actions-badge]][actions-url]
[![Actively Maintained](https://img.shields.io/badge/Maintenance%20Level-Actively%20Maintained-green.svg)](https://gist.github.com/cheerfulstoic/d107229326a01ff0f333a1d3476e068d)
Copy link
Member

Choose a reason for hiding this comment

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

👍

[![MPL-2.0][mpl-badge]][mpl-url]

`cameleon` is a safe, fast, and flexible library for [GenICam][genicam-url] compatible cameras.

Expand Down Expand Up @@ -182,6 +183,16 @@ To start developing, please refer to [CONTRIBUTING.md][contributing].

[contributing]: https://github.com/cameleon-rs/cameleon/blob/main/CONTRIBUTING.md

## Releasing
### 1. Publish
1. Bump up all the crate versions in the workspace using `cargo release version <major|minor|patch>`
2. Open a PR to reflect the changes.
3. Publish the crates with [`cargo release`](https://github.com/crate-ci/cargo-release)
Y-Nak marked this conversation as resolved.
Show resolved Hide resolved

### 2. Changelog
1. Create a new release on the GitHub page from the tag that `cargo release` has created
2. Use [automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) and modify it *manually*

## License
This project is licenced under [MPL 2.0][license].

Expand Down
Loading