Skip to content

Commit e0861f0

Browse files
Compatibility documentation (#312)
* Add compatiblity documentation
1 parent 5299571 commit e0861f0

File tree

2 files changed

+84
-0
lines changed

2 files changed

+84
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and
7676
- [**Authentication**](wiki/markdown/authentication.md)
7777
- [**Subscriptions**](wiki/markdown/subscription-API.md)
7878
- [**Download files**](wiki/markdown/download-files.md)
79+
1. [**Compatibility**](wiki/markdown/compatibility.md)
7980
1. [**Known limitations**](wiki/markdown/known-limitations.md)
8081

8182
**Eiffel Intelligence documentation** [**can be found here**](https://eiffel-community.github.io/eiffel-intelligence/)

wiki/markdown/compatibility.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Compatibility
2+
3+
We recommend using the latest version of back-end and front-end whenever possible. However, this page contains a compatibility matrix and notes when pairing different versions.
4+
5+
| |Front-end ➡ | | | |
6+
|---------------------:|:--------------------:|:--------------------:|:--------------------:|:--------------------:|
7+
|**Back-end ⬇** | 1.0.0| 1.0.1| 1.0.2| 1.0.3|
8+
|[1.0.0](#back-end-100)|[✔️️](#front-end-100) |[✔️️](#front-end-101) |[](#front-end-102) |[](#front-end-103) |
9+
|[1.0.1](#back-end-101)|[✔️️](#front-end-100-1) |[✔️️](#front-end-101-1) |[](#front-end-102-1)|[](#front-end-103-1)|
10+
|[1.0.2](#back-end-102)|[](#front-end-100-2)|[](#front-end-101-2)|[✔️️](#front-end-102-2) |[✔️️](#front-end-103-2) |
11+
12+
✔️️ Yes | ✅ Yes, minor Issue | ❕ Yes, medium Issue | ❌ No, major Issue
13+
<br>
14+
<br>
15+
## Back-end: 1.0.0
16+
#### Front-end: 1.0.0
17+
Compatible: ✔️️ Yes
18+
19+
Notes: -
20+
21+
#### Front-end: 1.0.1
22+
Compatible: ✔️️ Yes
23+
24+
Notes: -
25+
26+
#### Front-end: 1.0.2
27+
Compatible: ✅ Yes, minor Issue
28+
29+
Notes:
30+
- Documentation is based on the [Agen](https://github.com/eiffel-community/eiffel/blob/master/eiffel-syntax-and-usage/versioning.md#versioning) version of the Eiffel protocol but it’s still functional since the jmespath reference to purl package instead of gav does not change subscription structure.
31+
32+
#### Front-end: 1.0.3
33+
Compatible: ✅ Yes, minor Issue
34+
35+
Notes:
36+
- Documentation is based on the [Agen](https://github.com/eiffel-community/eiffel/blob/master/eiffel-syntax-and-usage/versioning.md#versioning) version of the Eiffel protocol but it’s still functional since the jmespath reference to purl package instead of gav does not change subscription structure.
37+
38+
## Back-end: 1.0.1
39+
#### Front-end: 1.0.0
40+
Compatible: ✔️️ Yes
41+
42+
Notes: -
43+
44+
#### Front-end: 1.0.1
45+
Compatible: ✔️️ Yes
46+
47+
Notes: -
48+
49+
#### Front-end: 1.0.2
50+
Compatible: ✅ Yes, minor Issue
51+
52+
Notes:
53+
- Documentation is based on the [Agen](https://github.com/eiffel-community/eiffel/blob/master/eiffel-syntax-and-usage/versioning.md#versioning) version of the Eiffel protocol but it’s still functional since the jmespath reference to purl package instead of gav does not change subscription structure.
54+
55+
#### Front-end: 1.0.3
56+
Compatible: ✅ Yes, minor Issue
57+
58+
Notes:
59+
- Documentation is based on the [Agen](https://github.com/eiffel-community/eiffel/blob/master/eiffel-syntax-and-usage/versioning.md#versioning) version of the Eiffel protocol but it’s still functional since the jmespath reference to purl package instead of gav does not change subscription structure.
60+
61+
## Back-end: 1.0.2
62+
#### Front-end: 1.0.0
63+
Compatible: ❕ Yes, medium Issue
64+
65+
Notes:
66+
- Documentation is based on the [Toulouse](https://github.com/eiffel-community/eiffel/blob/master/eiffel-syntax-and-usage/versioning.md#versioning) version of the Eiffel protocol but it’s still functional since the jmespath reference to gav package instead of purl does not change subscription structure.
67+
- Multiple e-mail recipients are not supported through the front-end subscription form. This becomes possible to do from front-end version [1.0.1](https://github.com/eiffel-community/eiffel-intelligence-frontend/releases/tag/1.0.1) and forward.
68+
69+
#### Front-end: 1.0.1
70+
Compatible: ✅ Yes, minor Issue
71+
72+
Notes:
73+
- Documentation is based on the [Toulouse](https://github.com/eiffel-community/eiffel/blob/master/eiffel-syntax-and-usage/versioning.md#versioning) version of the Eiffel protocol but it’s still functional since the jmespath reference to gav package instead of purl does not change subscription structure.
74+
75+
#### Front-end: 1.0.2
76+
Compatible: ✔️️ Yes
77+
78+
Notes: -
79+
80+
#### Front-end: 1.0.3
81+
Compatible: ✔️️ Yes
82+
83+
Notes: -

0 commit comments

Comments
 (0)