Skip to content

Commit 779bf30

Browse files
docs: update release notes
1 parent db6ceb5 commit 779bf30

File tree

3 files changed

+37
-2
lines changed

3 files changed

+37
-2
lines changed

docs/docs/release-notes/0.17.md

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

docs/docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ const config: Config = {
7474
label: 'Docs',
7575
},
7676
{
77-
to: '/docs/release-notes/0.16',
77+
to: '/docs/release-notes/0.17',
7878
label: 'Release Notes',
7979
position: 'left',
8080
},

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)