fix CI and readme

Author: RensR

.github/workflows/solidity-build-and-publish.yml

@@ -215,16 +215,16 @@ jobs:
           IS_RELEASE_CCIP: ${{ needs.tag-check.outputs.is-release-ccip }}
           RELEASE_VERSION_CCIP: ${{ needs.tag-check.outputs.release-version-ccip }}
         run: |
-          version=""
-          if [[ $IS_RELEASE_CCIP == 'true' ]]; then
-            version="${RELEASE_VERSION_CCIP}"
+          VERSION=""
+          if [[ "${IS_RELEASE_CCIP}" == 'true' ]]; then
+            VERSION="${RELEASE_VERSION_CCIP}"
           else
             echo "::error::No release version found."
             exit 1
           fi
-          package_json_version="$(jq -r '.version' package.json)"
-          if [[ "$PACKAGE_JSON_VERSION" != "${version}" ]]; then
-            echo "::error version mismatch: package.json version ($package_json_version) does not match version computed from tag ${version}"
+          PACKAGE_JSON_VERSION="$(jq -r '.version' package.json)"
+          if [[ "${PACKAGE_JSON_VERSION}" != "${VERSION}" ]]; then
+            echo "::error::Version mismatch: package.json version (${PACKAGE_JSON_VERSION}) does not match version computed from tag ${VERSION}"
             exit 1
           fi
 

chains/evm/README.md

@@ -1,34 +1,109 @@
 # Chainlink CCIP Smart Contracts
 
+> [!IMPORTANT] 
+> Since v1.6.0 of the CCIP contracts, the contracts have been moved to a new repository:
+> [chainlink-ccip](https://github.com/smartcontractkit/chainlink-ccip).
+> The EVM contracts exist in the `chains/evm` directory of the repository.
+
 ## Installation
 
+Chainlink-ccip relies on chainlink-evm, below are the instructions to install both.
+To find the correct version of chainlink-evm to use for any given version of chainlink-ccip, 
+please refer to the `package.json` file in `/chains/evm`.
+It contains an NPM dependency on `@chainlink/contracts-evm` with the correct version for the given version of chainlink-ccip.
+
+NOTE: while other versions of chainlink-evm may work, we only test against the version specified in the `package.json` file.
+Audits are also only done against the version specified in the `package.json` file. 
+No guarantees are made for other versions.
+
+#### Foundry (git)
+
+> [!WARNING]
+> When installing via git, the ref defaults to master when no tag is given.
+
+When installing through git, it is recommended to use a specific version tag to avoid breaking changes.
+The corresponding git tag will be `contracts-ccip/v<version>` for chainlink-ccip, 
+and `contracts/v<version>` for chainlink-evm.
+
+```sh
+$ forge install smartcontractkit/chainlink-evm@<version_tag>
+$ forge install smartcontractkit/chainlink-ccip@<version_tag>
+```
+
+Add the following remappings
+
+```
+@chainlink/contracts/=lib/smartcontractkit/chainlink-evm/contracts/
+@chainlink/contracts-ccip/contracts/=lib/smartcontractkit/chainlink-ccip/chains/evm/contracts/
+```
+#### NPM
+
 ```sh
-# via pnpm
+# pnpm
+$ pnpm add @chainlink/contracts-evm
 $ pnpm add @chainlink/contracts-ccip
-# via npm
+```
+```sh
+# npm
+$ npm install @chainlink/contracts-evm --save
 $ npm install @chainlink/contracts-ccip --save
 ```
 
+Add the following remappings
+
+```
+@chainlink/contracts/=node_modules/@chainlink/contracts/
+@chainlink/contracts-ccip/contracts/=node_modules/@chainlink/contracts-ccip/contracts/
+```
+
 ### Directory Structure
 
 ```sh
 @chainlink/contracts-ccip
 ├── contracts # Solidity contracts
+├── scripts # Compilation script
 └── abi # ABI json output
 ```
 
 ### Usage
 
-The solidity smart contracts themselves can be imported via the `contracts` directory of `@chainlink/contracts-ccip`:
+> [!WARNING]
+> Contracts in `dev/` directories or with a typeAndVersion ending in `-dev` are under active development
+> and are likely unaudited.
+> Please refrain from using these in production applications.
+
+
+The contracts can be imported via `@chainlink/contracts-ccip/contracts`:
 
 ```solidity
-import '@chainlink/contracts-ccip/contracts/applications/CCIPReceiver.sol';
+import {CCIPReceiver} from '@chainlink/contracts-ccip/contracts/applications/CCIPReceiver.sol';
 ```
 
+#### Getting started with CCIP
+
+To get started with CCIP, please refer to the [CCIP documentation](https://docs.chain.link/ccip).
+
+The MockRouter contract is a good starting point when developing dapps that use CCIP.
+It is a simplified same-chain entry and exit point for CCIP messages.
+It lives in `contracts/test/mocks/MockRouter.sol`.
+
+
 ### Remapping
 
-This repository uses [Solidity remappings](https://docs.soliditylang.org/en/v0.8.20/using-the-compiler.html#compiler-remapping) to resolve imports.
-The remapping is defined in the `remappings.txt` file.
+This repository uses [Solidity remappings](https://docs.soliditylang.org/en/v0.8.20/using-the-compiler.html#compiler-remapping) to resolve imports, 
+which are defined in the `remappings.txt` file.
+
+Please see the Installation section above for the correct remappings based on your installation method.
+
+If required, you can remap dependencies used within CCIP contracts, e.g. Openzeppelin contracts,
+by adding the following to your `remappings.txt` file:
+
+```
+@chainlink/contracts/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/=node_modules/@openzeppelin/contracts/
+@chainlink/contracts/src/v0.8/vendor/openzeppelin-solidity/v5.0.2/contracts/=node_modules/@openzeppelin/contracts/
+```
+
+This allows you to use a wide range of versions of Openzeppelin in your project without conflicts.
 
 ### Changesets
 

chains/evm/package.json

@@ -3,6 +3,7 @@
   "version": "1.6.0",
   "description": "Chainlink smart contracts for CCIP",
   "author": "Chainlink devs",
+  "repository": "github:smartcontractkit/chainlink-ccip",
   "license": "BUSL-1.1",
   "private": false,
   "scripts": {