Skip to content

Commit

Permalink
Link to changelog and releases from README (#294)
Browse files Browse the repository at this point in the history
  • Loading branch information
john-h-kastner-aws authored Aug 30, 2023
1 parent 9f8393d commit 716e841
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 23 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,11 @@ Generated documentation for the latest version of the Rust crates can be accesse

To build, simply run `cargo build` (or `cargo build --release`).

## What's new / Changelog

We maintain changelogs for our public-facing crates: [cedar-policy](./cedar-policy/CHANGELOG.md) and [cedar-policy-cli](./cedar-policy-cli/CHANGELOG.md).
For a list of the current and past releases, see [crates.io](https://crates.io/crates/cedar-policy) or [Releases](https://github.com/cedar-policy/cedar/releases).

## Security

See [SECURITY](SECURITY.md) for more information.
Expand Down
10 changes: 10 additions & 0 deletions cedar-policy-cli/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,19 @@

### Changed
- Input policies for `check-parse` command can be read from standard input.

### Fixed
- Duplicate policy ids in `@id` annotations cause the CLI to exit gracefully
instead of panicking.

## 2.3.3

## 2.3.2

## 2.3.1

## 2.3.0

## 2.2.0

### Changed
Expand Down
67 changes: 44 additions & 23 deletions cedar-policy/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,60 +2,81 @@

## Unreleased

- Move public API for partial evaluation behind experimental feature flag.
- Added an option to eagerly evaluate entity attributes and re-use across calls to `is_authorized`
- Revamped errors in cst-to-ast transformation
- Adds APIs to `Entities` to make it easy to add a collection of entities to an existing `Entities` structure

### Added

- Export `entities::EntitiesError` error type.
- Added an option to eagerly evaluate entity attributes and re-use across calls to `is_authorized`
- Adds APIs to `Entities` to make it easy to add a collection of entities to an existing `Entities` structure
- New methods exported for `EntityTypeName`.
- `basename` to get the basename (without namespaces).
- `namespace_components` to get the namespace as an iterator over its components.
- `namespace` to get the namespace as a single string.
- Fixed bug (#150) around implicit namespaces in action definitions.
- Support `Request`s with `Unknown` fields for partial evaluation.
- Export the `cedar_policy_core::evaluator::{EvaluationError, EvaluationErrorKind}` and
`cedar_policy_core::authorizer::AuthorizationError` error types.

### Changed

- Revamped errors in cst-to-ast transformation
- Added list of attributes that do exist to `RecordAttrDoesNotExist` error message.
- Removed deprecated `__expr` escapes from integration tests.
- Improved error detection in schema based parsing (fix issues #73, #74).
- Detect entities with parents of an incorrect entity type.
- Detect entities with an undeclared entity type.
- Slightly improved error text on some validation type errors
- Improved error messages for some schema type parsing errors
- When an entity type shape or action context is declared with type other
than `Record`, the error message will indicate the effected entity type or
action.
- Parsing a schema type without the `"type"` field will generate an error
stating that `"type"` is a required field instead of an inscrutable error
complaining about the untagged enum `SchemaType`.
- Parsing a schema type with a `"type"` field corresponding to one of the
builtin types but missing a required field for that type will generate an
error stating that a required field is missing instead of claiming that it
could not find "common types" definition for that builtin type.
- Some error types now carry more information about the error, with error
messages updated appropriately
- Update how record types are treated by the validator to support "open" and
"closed" record types. Record types written in schema are now closed. In
particular, this applies to the action context, so `context has attr` can now
have type False where before it had type Boolean, creating some new
short-circuiting opportunities. The same applies to record literals.
- Improved error messages and documentation for some errors raised during
policy evaluation.
- Fix a panic in `PolicySet::link` that could occur when the function was called
with a policy id corresponding to a static policy.
- Renamed `cedar_policy_core::est::EstToAstError` to `cedar_policy_core::est::FromJsonError`
- More precise "expected tokens" lists in some parse errors
- Renamed `cedar_policy_core::entities::JsonDeserializationError::ExtensionsError` to `cedar_policy_core::entities::JsonDeserializationError::FailedExtensionsFunctionLookup`.
- Renamed variants in `cedar_policy::SchemaError`
- The `Diagnostics::errors()` function now returns an iterator over `AuthorizationError`s.
- The `Response::new()` constructor now expects a `Vec<AuthorizationError>` as its third argument.

## 2.3.3

### Added
- Re-export `cedar_policy_core::entities::EntitiesError`.
- Fixed bug (#150) around implicit namespaces for actions in `memberOf` lists in
schemas. An action without an explicit namespace in a `memberOf` now
correctly uses the default namespace.

### Changed
- Improved error messages and documentation for some errors raised during
policy parsing, validation, and evaluation.
- More precise "expected tokens" lists in some parse errors.

## 2.3.2

### Removed
- Move public API for partial evaluation behind experimental feature flag. To
continue using this feature you must enable the `partial-eval` feature flag.

### Changed

- Improved error detection in schema based parsing (fix issues #73, #74).
- Detect entities with parents of an incorrect entity type.
- Detect entities with an undeclared entity type.
- Slightly improved error text on some validation type errors
- Improved error messages for some schema type parsing errors
- Parsing a schema type without the `"type"` field will generate an error
stating that `"type"` is a required field instead of an inscrutable error
complaining about the untagged enum `SchemaType`.
- Parsing a schema type with a `"type"` field corresponding to one of the
builtin types but missing a required field for that type will generate an
error stating that a required field is missing instead of claiming that it
could not find "common types" definition for that builtin type.

## 2.3.1

### Fixed

- Fix a panic in `PolicySet::link()` that could occur when the function was called
with a policy id corresponding to a static policy.

## 2.3.0

### Changed
Expand Down

0 comments on commit 716e841

Please sign in to comment.