Skip to content

Commit 954e3cb

Browse files
docs: update release notes
1 parent db6ceb5 commit 954e3cb

2 files changed

Lines changed: 38 additions & 1 deletion

File tree

docs/docs/release-notes/0.17.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: 0.17
3+
displayed_sidebar: releaseNotesSidebar
4+
---
5+
6+
## Version 0.17
7+
8+
## Version 0.17
9+
10+
The algorithm for dependency rules has been updated, which may introduce breaking changes.
11+
12+
When a module attempts to access another module, the following steps are executed to determine if the access is allowed:
13+
14+
- Sheriff retrieves the tags for both modules.
15+
- For each tag in the "from" module, Sheriff checks if it has clearance to access the corresponding tag in the "to" module.
16+
17+
```mermaid
18+
stateDiagram-v2
19+
[*] --> RequestAccessToModule
20+
RequestAccessToModule --> GetFromAndToTags
21+
GetFromAndToTags --> IterateOverFromTags
22+
IterateOverFromTags --> HasFromTagAccessToAnyToTag
23+
HasFromTagAccessToAnyToTag --> AccessDenied: No
24+
HasFromTagAccessToAnyToTag --> MoreFromTagsAvailable: Yes
25+
MoreFromTagsAvailable --> AccessGranted: No
26+
MoreFromTagsAvailable --> IterateOverFromTags: Yes
27+
AccessGranted --> [*]
28+
AccessDenied --> [*]
29+
```
30+
31+
For more information, see the [dependency rules documentation](../dependency-rules).
32+
33+
:::note
34+
35+
It is very likely that most applications will not be affected by this change. However, if you encounter issues, please file a bug report.
36+
37+
:::

docs/sidebars.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
1313
const sidebars: SidebarsConfig = {
1414
// By default, Docusaurus generates a sidebar from the docs folder structure
1515
tutorialSidebar: ['introduction', 'installation', 'module_boundaries', 'dependency-rules', 'cli', 'integration'],
16-
releaseNotesSidebar: [{type: 'category', label: 'Release Notes', items: ['release-notes/0.16']}],
16+
releaseNotesSidebar: [{type: 'category', label: 'Release Notes', items: ['release-notes/0.17', 'release-notes/0.16']}],
1717
roadmapSidebar: ['roadmap'],
1818
};
1919

0 commit comments

Comments
 (0)