Skip to content

Commit a9eda3e

Browse files
Amxxernestognw
andauthored
Add notice about the use of NPM tags in README.md (#6050)
Co-authored-by: ernestognw <ernestognw@gmail.com>
1 parent 17be150 commit a9eda3e

File tree

3 files changed

+64
-12
lines changed

3 files changed

+64
-12
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,29 @@
2020
2121
## Overview
2222

23+
### Release tags
24+
25+
We use NPM tags to clearly distinguish between audited and non-audited versions of our package:
26+
27+
| Tag | Purpose | Description |
28+
| :--------- | :----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
29+
| **latest** | ✅ Audited releases | Stable, audited versions of the package. This is the **default** version installed when users run `npm install @openzeppelin/contracts`. |
30+
| **dev** | 🧪 Final but not audited | Versions that are finalized and feature-complete but have **not yet been audited**. This version is fully tested, can be used in production and is covered by the bug bounty. |
31+
| **next** | 🚧 Release candidates | Pre-release versions that are **not final**. Used for testing and validation before the version becomes a final `dev` or `latest` release. |
32+
2333
### Installation
2434

2535
#### Hardhat (npm)
2636

2737
```
2838
$ npm install @openzeppelin/contracts
2939
```
40+
→ Installs the latest audited release (`latest`).
41+
42+
```
43+
$ npm install @openzeppelin/contracts@dev
44+
```
45+
→ Installs the latest unaudited release (`dev`).
3046

3147
#### Foundry (git)
3248

docs/modules/ROOT/pages/index.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,30 @@ IMPORTANT: OpenZeppelin Contracts uses semantic versioning to communicate backwa
1010

1111
== Overview
1212

13+
[[release-tags]]
14+
=== Release Tags
15+
16+
We use NPM tags to clearly distinguish between audited and non-audited versions of our package:
17+
18+
[%header,cols=3*]
19+
|===
20+
| *Tag*
21+
| *Purpose*
22+
| *Description*
23+
24+
| *latest*
25+
| ✅ Audited releases
26+
| Stable, audited versions of the package. This is the *default* version installed when users run `npm install @openzeppelin/contracts`.
27+
28+
| *dev*
29+
| 🧪 Final but not audited
30+
| Versions that are finalized and feature-complete but have *not yet been audited*. This version is fully tested, can be used in production and is covered by the bug bounty.
31+
32+
| *next*
33+
| 🚧 Release candidates
34+
| Pre-release versions that are *not final*. Used for testing and validation before the version becomes a final `dev` or `latest` release.
35+
|===
36+
1337
[[install]]
1438
=== Installation
1539

@@ -18,6 +42,12 @@ IMPORTANT: OpenZeppelin Contracts uses semantic versioning to communicate backwa
1842
```console
1943
$ npm install @openzeppelin/contracts
2044
```
45+
→ Installs the latest audited release (`latest`).
46+
47+
```
48+
$ npm install @openzeppelin/contracts@dev
49+
```
50+
→ Installs the latest unaudited release (`dev`).
2151

2252
==== Foundry (git)
2353

scripts/upgradeable/upgradeable.patch

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@ index ff596b0c3..000000000
5959
-<!-- Make sure that you have reviewed the OpenZeppelin Contracts Contributor Guidelines. -->
6060
-<!-- https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/CONTRIBUTING.md -->
6161
diff --git a/README.md b/README.md
62-
index 2f92281b3..a0e46695d 100644
62+
index 6a01f5616..168b74aa7 100644
6363
--- a/README.md
6464
+++ b/README.md
65-
@@ -20,6 +20,9 @@
65+
@@ -18,6 +18,9 @@
6666
> [!IMPORTANT]
6767
> OpenZeppelin Contracts uses semantic versioning to communicate backwards compatibility of its API and storage layout. For upgradeable contracts, the storage layout of different major versions should be assumed incompatible, for example, it is unsafe to upgrade from 4.9.3 to 5.0.0. Learn more at [Backwards Compatibility](https://docs.openzeppelin.com/contracts/backwards-compatibility).
6868

@@ -71,17 +71,23 @@ index 2f92281b3..a0e46695d 100644
7171
++
7272
## Overview
7373

74-
### Installation
75-
@@ -27,7 +30,7 @@
74+
### Release tags
75+
@@ -35,12 +38,12 @@ We use NPM tags to clearly distinguish between audited and non-audited versions
7676
#### Hardhat (npm)
7777

7878
```
7979
-$ npm install @openzeppelin/contracts
8080
+$ npm install @openzeppelin/contracts-upgradeable
8181
```
82+
→ Installs the latest audited release (`latest`).
8283

83-
#### Foundry (git)
84-
@@ -39,10 +42,10 @@ $ npm install @openzeppelin/contracts
84+
```
85+
-$ npm install @openzeppelin/contracts@dev
86+
+$ npm install @openzeppelin/contracts-upgradeable@dev
87+
```
88+
→ Installs the latest unaudited release (`dev`).
89+
90+
@@ -53,10 +56,10 @@ $ npm install @openzeppelin/contracts@dev
8591
> Foundry installs the latest version initially, but subsequent `forge update` commands will use the `master` branch.
8692

8793
```
@@ -94,7 +100,7 @@ index 2f92281b3..a0e46695d 100644
94100

95101
### Usage
96102

97-
@@ -51,10 +54,11 @@ Once installed, you can use the contracts in the library by importing them:
103+
@@ -65,10 +68,11 @@ Once installed, you can use the contracts in the library by importing them:
98104
```solidity
99105
pragma solidity ^0.8.20;
100106

@@ -110,15 +116,15 @@ index 2f92281b3..a0e46695d 100644
110116
}
111117
```
112118
diff --git a/contracts/package.json b/contracts/package.json
113-
index 8ccb9465e..509cd7f05 100644
119+
index 3535a2f56..9a73abc22 100644
114120
--- a/contracts/package.json
115121
+++ b/contracts/package.json
116122
@@ -1,5 +1,5 @@
117123
{
118124
- "name": "@openzeppelin/contracts",
119125
+ "name": "@openzeppelin/contracts-upgradeable",
120126
"description": "Secure Smart Contract library for Solidity",
121-
"version": "5.4.0",
127+
"version": "5.5.0",
122128
"files": [
123129
@@ -13,7 +13,7 @@
124130
},
@@ -140,7 +146,7 @@ index 8ccb9465e..509cd7f05 100644
140146
+ }
141147
}
142148
diff --git a/contracts/utils/ReentrancyGuard.sol b/contracts/utils/ReentrancyGuard.sol
143-
index 6e44894dc..7b076aaa7 100644
149+
index c156fa1cc..895e39342 100644
144150
--- a/contracts/utils/ReentrancyGuard.sol
145151
+++ b/contracts/utils/ReentrancyGuard.sol
146152
@@ -36,6 +36,11 @@ abstract contract ReentrancyGuard {
@@ -167,7 +173,7 @@ index 6e44894dc..7b076aaa7 100644
167173
* @dev Prevents a contract from calling itself, directly or indirectly.
168174
* Calling a `nonReentrant` function from another `nonReentrant`
169175
diff --git a/contracts/utils/cryptography/EIP712.sol b/contracts/utils/cryptography/EIP712.sol
170-
index 0eaef9d27..01f1b5f58 100644
176+
index 2bc45a4b2..09e84815e 100644
171177
--- a/contracts/utils/cryptography/EIP712.sol
172178
+++ b/contracts/utils/cryptography/EIP712.sol
173179
@@ -4,7 +4,6 @@
@@ -341,7 +347,7 @@ index 0eaef9d27..01f1b5f58 100644
341347
}
342348
}
343349
diff --git a/package.json b/package.json
344-
index f6960972a..369e2e1e6 100644
350+
index 0e387a8e7..4f2a6bea6 100644
345351
--- a/package.json
346352
+++ b/package.json
347353
@@ -35,7 +35,7 @@

0 commit comments

Comments
 (0)