ips/README.md

# Image Packaging System for illumos

## libips
The libips crate contains all modules and functions one needs to implement an Image Packaging System based utility.

Be that a server, client or other utilities. 

This project is intended to gradually replace the 
[current python based implementation of IPS](https://github.com/openindiana/pkg5). 
Most things are documented in the [docs](https://github.com/OpenIndiana/pkg5/tree/oi/doc) directory 
but some things have been added over the years which has not been properly documented. Help is welcome 
but be advised, this is mainly intended for use within the illumos community and it's distributions.
Big changes which are not in the current IPS will need to be carefully coordinated to not break the current
IPS.

## Development and Release

### Releasing

This project uses `cargo-release` for versioning and tagging.

1. Ensure you have `cargo-release` installed: `cargo install cargo-release`
2. Prepare the release (dry-run): `cargo release [level] --dry-run` (e.g., `cargo release patch --dry-run`)
3. Execute the release: `cargo release [level] --execute`
4. Push the changes and tags: `git push --follow-tags`

Pushing a tag starting with `v` (e.g., `v0.5.1`) will trigger the GitHub Actions release pipeline, which builds artifacts for Illumos (OpenIndiana) and Linux, and creates a GitHub Release.
Update README.md 2021-03-21 14:45:33 -03:00			`# Image Packaging System for illumos`
Add MPL V2 license 2020-05-17 21:52:39 +02:00
Update README.md 2021-03-21 14:45:33 -03:00			`## libips`
			`The libips crate contains all modules and functions one needs to implement an Image Packaging System based utility.`
Add MPL V2 license 2020-05-17 21:52:39 +02:00
Publish Placeholder package to crates.io 2020-06-04 15:53:50 +02:00			`Be that a server, client or other utilities.`

Add note for crate.io 2020-06-04 21:44:52 +02:00			`This project is intended to gradually replace the`
			`[current python based implementation of IPS](https://github.com/openindiana/pkg5).`
			`Most things are documented in the [docs](https://github.com/OpenIndiana/pkg5/tree/oi/doc) directory`
			`but some things have been added over the years which has not been properly documented. Help is welcome`
			`but be advised, this is mainly intended for use within the illumos community and it's distributions.`
			`Big changes which are not in the current IPS will need to be carefully coordinated to not break the current`
Update README.md 2021-03-21 14:45:33 -03:00			`IPS.`
Remove Jenkinsfile, add Illumos builds to GitHub Actions, and document release process - Deleted the Jenkinsfile, transitioning all CI workflows to GitHub Actions. - Added Illumos (OpenIndiana) build and release steps to GitHub workflows. - Created a new release pipeline triggered by version tags starting with `v`. - Updated README with release instructions using `cargo-release`. 2026-01-18 14:59:24 +01:00
			`## Development and Release`

			`### Releasing`

			This project uses `cargo-release` for versioning and tagging.

			1. Ensure you have `cargo-release` installed: `cargo install cargo-release`
			2. Prepare the release (dry-run): `cargo release [level] --dry-run` (e.g., `cargo release patch --dry-run`)
			3. Execute the release: `cargo release [level] --execute`
			4. Push the changes and tags: `git push --follow-tags`

			Pushing a tag starting with `v` (e.g., `v0.5.1`) will trigger the GitHub Actions release pipeline, which builds artifacts for Illumos (OpenIndiana) and Linux, and creates a GitHub Release.