Skip to content

Commit

Permalink
docs: update release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
rainerhahnekamp committed Sep 2, 2024
1 parent db6ceb5 commit 954e3cb
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
37 changes: 37 additions & 0 deletions docs/docs/release-notes/0.17.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: 0.17
displayed_sidebar: releaseNotesSidebar
---

## Version 0.17

## Version 0.17

The algorithm for dependency rules has been updated, which may introduce breaking changes.

When a module attempts to access another module, the following steps are executed to determine if the access is allowed:

- Sheriff retrieves the tags for both modules.
- For each tag in the "from" module, Sheriff checks if it has clearance to access the corresponding tag in the "to" module.

```mermaid
stateDiagram-v2
[*] --> RequestAccessToModule
RequestAccessToModule --> GetFromAndToTags
GetFromAndToTags --> IterateOverFromTags
IterateOverFromTags --> HasFromTagAccessToAnyToTag
HasFromTagAccessToAnyToTag --> AccessDenied: No
HasFromTagAccessToAnyToTag --> MoreFromTagsAvailable: Yes
MoreFromTagsAvailable --> AccessGranted: No
MoreFromTagsAvailable --> IterateOverFromTags: Yes
AccessGranted --> [*]
AccessDenied --> [*]
```

For more information, see the [dependency rules documentation](../dependency-rules).

:::note

It is very likely that most applications will not be affected by this change. However, if you encounter issues, please file a bug report.

:::
2 changes: 1 addition & 1 deletion docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
const sidebars: SidebarsConfig = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: ['introduction', 'installation', 'module_boundaries', 'dependency-rules', 'cli', 'integration'],
releaseNotesSidebar: [{type: 'category', label: 'Release Notes', items: ['release-notes/0.16']}],
releaseNotesSidebar: [{type: 'category', label: 'Release Notes', items: ['release-notes/0.17', 'release-notes/0.16']}],
roadmapSidebar: ['roadmap'],
};

Expand Down

0 comments on commit 954e3cb

Please sign in to comment.