From f3b1dbaef6bd5b72925123454a6f5160dfa73f47 Mon Sep 17 00:00:00 2001 From: Kir Kolyshkin Date: Thu, 25 Jul 2024 08:14:30 -0700 Subject: [PATCH] Add README and CHANGELOG Signed-off-by: Kir Kolyshkin --- CHANGELOG.md | 41 +++++++++++++++++++++++++++++++++++++++++ README.md | 11 +++++++++++ 2 files changed, 52 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 README.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..fbb9038 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,41 @@ +# Changelog +This file documents all notable changes made to this project since the initial fork. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [0.1.0] - 2024-07-31 + +This is an initial release since the fork. + +### Breaking changes + + * The `CAP_LAST_CAP` variable is removed; users need to modify the code to + use [LastCap] to get the value. (#6) + * The code now requires Go >= 1.20. + +### Added + * `go.mod` and `go.sum` files. (#2) + * New [LastCap] function. (#6) + * Basic CI using GHA infra. (#8, #9) + * README and CHANGELOG. (#10) + +### Fixed + * Fixed ambient capabilities error handling in [Apply]. (#3) + * Fixed future kernel compatibility. (#1) + * Fixed various linter warnings. (#4, #7) + +### Changed + * Go build tags changed from old-style (`+build`) to new Go 1.17+ style (`go:build`). (#2) + +### Removed + * Removed support for capabilities v1 and v2. (#1) + * Removed init function so programs that use this package start faster. (#6) + * Removed `CAP_LAST_CAP` (use [LastCap] instead). (#6) + +[Apply]: https://pkg.go.dev/github.com/kolyshkin/capability#Capabilities.Apply +[LastCap]: https://pkg.go.dev/github.com/kolyshkin/capability#LastCap + + +[0.1.0]: https://github.com/kolyshkin/capability/compare/42c35b4376354fd5...v0.1.0 + diff --git a/README.md b/README.md new file mode 100644 index 0000000..074731a --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +This is a fork of (apparently no longer maintained) +https://github.com/syndtr/gocapability package. It provides basic primitives to +work with [Linux capabilities][capabilities(7)]. + +[![Go Reference](https://pkg.go.dev/badge/github.com/kolyshkin/capability.svg)](https://pkg.go.dev/github.com/kolyshkin/capability) + +## Alternatives + + * https://pkg.go.dev/kernel.org/pub/linux/libs/security/libcap/cap + +[capabilities(7)]: https://man7.org/linux/man-pages/man7/capabilities.7.html