diff --git a/README.md b/README.md index f111440a..bad23355 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ changed package (otherwise you might get weird JS/TS errors). Signed API and Airnode feed use [semantic versioning](https://semver.org/). Packages are published to NPM to export the configuration schemas and various utilities. The services are dockerized and published to Docker Hub. -There is a script that automates the process of creating a new NPM version. Full release procedure: +There is a script that automates the process of creating new NPM versions and Docker images. Full release procedure: 1. `pnpm run create-npm-release [major|minor|patch]` - The script ensures publishing happens from up-to-date `main` branch. It updates the package versions for `airnode-feed` and `signed-api`, updates fixtures and example files, does diff --git a/package.json b/package.json index dab75566..a7793586 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "signed-api", - "version": "2.4.0", + "version": "0.1.0", "engines": { "node": ">=18.19.0", "pnpm": "^8.12.0" @@ -17,8 +17,8 @@ "prepare": "husky install", "prettier:check": "pnpm recursive run prettier:check", "prettier:fix": "pnpm recursive run prettier:fix", - "publish:airnode-feed": "cd packages/airnode-feed && pnpm publish --access public --registry http://localhost:4873 --no-git-checks", - "publish:signed-api": "cd packages/signed-api && pnpm publish --access public --registry http://localhost:4873 --no-git-checks", + "publish:airnode-feed": "cd packages/airnode-feed && pnpm publish --access public", + "publish:signed-api": "cd packages/signed-api && pnpm publish --access public", "test": "pnpm recursive run test", "tsc": "pnpm recursive run tsc" }, diff --git a/packages/airnode-feed/CHANGELOG.md b/packages/airnode-feed/CHANGELOG.md deleted file mode 100644 index 930dfa80..00000000 --- a/packages/airnode-feed/CHANGELOG.md +++ /dev/null @@ -1,7 +0,0 @@ -# airnode-feed - -## 1.1.0 - -### Minor Changes - -- 8fb01ee: Support versioning diff --git a/packages/airnode-feed/README.md b/packages/airnode-feed/README.md index 1b703805..5562f2a2 100644 --- a/packages/airnode-feed/README.md +++ b/packages/airnode-feed/README.md @@ -352,26 +352,6 @@ An identifier of the deployment stage. This is used to distinguish between diffe example `dev`, `staging` or `production`. The stage value can have 256 characters at maximum and can only include lowercase alphanumeric characters and hyphens. -## Versioning and release - -Airnode feed uses [semantic versioning](https://semver.org/). The version is specified in the `package.json` file. The -package is not published to NPM, but instead dockerized and published to Docker Hub. - -To release a new version: - -1. `git checkout main` - Always version from `main` branch. Also, ensure that the working directory is clean (has no - uncommitted changes). -2. `cd packages/airnode-feed` - Navigate to the Airnode feed package. -3. `pnpm version [major|minor|patch]` - Choose the right version bump. This will bump the version, create a git tag and - commit it. -4. Build the docker image with tag `api3/airnode-feed:latest`. If running on Linux, use `pnpm run docker:build` - otherwise use `pnpm run docker:build:amd64`. -5. `docker tag api3/airnode-feed:latest api3/airnode-feed:` - Tag the image with the version. Replace - the `` with the version you just bumped (copy it from `package.json`). -6. `docker push api3/airnode-feed:latest && docker push api3/airnode-feed:` - Push the image - upstream. Both the latest and the versioned tag should be published. -7. `git push --follow-tags` - Push the tagged commit upstream. - ## Deployment diff --git a/packages/airnode-feed/config/airnode-feed.example.json b/packages/airnode-feed/config/airnode-feed.example.json index cd9f64c9..61bc0bdd 100644 --- a/packages/airnode-feed/config/airnode-feed.example.json +++ b/packages/airnode-feed/config/airnode-feed.example.json @@ -90,7 +90,7 @@ } ], "nodeSettings": { - "nodeVersion": "2.4.0", + "nodeVersion": "0.1.0", "airnodeWalletMnemonic": "${WALLET_MNEMONIC}", "stage": "local-example" } diff --git a/packages/airnode-feed/package.json b/packages/airnode-feed/package.json index 9258e45f..f674df57 100644 --- a/packages/airnode-feed/package.json +++ b/packages/airnode-feed/package.json @@ -1,6 +1,6 @@ { "name": "@api3/airnode-feed", - "version": "2.4.0", + "version": "0.1.0", "engines": { "node": ">=18.19.0", "pnpm": "^8.12.0" diff --git a/packages/e2e/src/airnode-feed/airnode-feed.json b/packages/e2e/src/airnode-feed/airnode-feed.json index 8cff6d38..816467d9 100644 --- a/packages/e2e/src/airnode-feed/airnode-feed.json +++ b/packages/e2e/src/airnode-feed/airnode-feed.json @@ -104,7 +104,7 @@ ], "apiCredentials": [], "nodeSettings": { - "nodeVersion": "2.4.0", + "nodeVersion": "0.1.0", "airnodeWalletMnemonic": "diamond result history offer forest diagram crop armed stumble orchard stage glance", "stage": "local-example" } diff --git a/packages/e2e/src/signed-api/signed-api.json b/packages/e2e/src/signed-api/signed-api.json index dbb48c28..c4447392 100644 --- a/packages/e2e/src/signed-api/signed-api.json +++ b/packages/e2e/src/signed-api/signed-api.json @@ -15,5 +15,5 @@ { "address": "0xbF3137b0a7574563a23a8fC8badC6537F98197CC", "authTokens": ["some-secret-token-for-airnode-feed"] } ], "stage": "e2e-test", - "version": "2.4.0" + "version": "0.1.0" } diff --git a/packages/performance-test/CHANGELOG.md b/packages/performance-test/CHANGELOG.md deleted file mode 100644 index d000ff7f..00000000 --- a/packages/performance-test/CHANGELOG.md +++ /dev/null @@ -1,3 +0,0 @@ -# e2e - -## 1.1.0 diff --git a/packages/performance-test/airnode-feed/create-config.ts b/packages/performance-test/airnode-feed/create-config.ts index c799bc7c..2aeb3bb3 100644 --- a/packages/performance-test/airnode-feed/create-config.ts +++ b/packages/performance-test/airnode-feed/create-config.ts @@ -45,7 +45,7 @@ const configTemplate = { ], apiCredentials: [], nodeSettings: { - nodeVersion: '2.4.0', + nodeVersion: '0.1.0', airnodeWalletMnemonic: 'destroy manual orange pole pioneer enemy detail lady cake bus shed visa', stage: 'performance-test', }, diff --git a/packages/performance-test/signed-api/signed-api.json b/packages/performance-test/signed-api/signed-api.json index 68107414..ce2d4dea 100644 --- a/packages/performance-test/signed-api/signed-api.json +++ b/packages/performance-test/signed-api/signed-api.json @@ -18,6 +18,6 @@ } ], "allowedAirnodes": "*", - "version": "2.4.0", + "version": "0.1.0", "stage": "perf-test" } diff --git a/packages/signed-api/CHANGELOG.md b/packages/signed-api/CHANGELOG.md deleted file mode 100644 index 9f54a551..00000000 --- a/packages/signed-api/CHANGELOG.md +++ /dev/null @@ -1,7 +0,0 @@ -# api - -## 1.1.0 - -### Minor Changes - -- 8fb01ee: Support versioning diff --git a/packages/signed-api/README.md b/packages/signed-api/README.md index 0b6a41c2..45902b10 100644 --- a/packages/signed-api/README.md +++ b/packages/signed-api/README.md @@ -264,26 +264,6 @@ The API provides the following endpoints: - Returns all Airnode addresses for which there is signed data. It is possible that this data cannot be shown by the delayed endpoints (in case the data is too fresh and there is not an older alternative). -## Versioning and release - -Signed API uses [semantic versioning](https://semver.org/). The version is specified in the `package.json` file. The -package is not published to NPM, but instead dockerized and published to Docker Hub. - -To release a new version: - -1. `git checkout main` - Always version from `main` branch. Also, ensure that the working directory is clean (has no - uncommitted changes). -2. `cd packages/api` - Change directory to the API package. -3. `pnpm version [major|minor|patch]` - Choose the right version bump. This will bump the version, create a git tag and - commit it. -4. Build the docker image with tag `api3/signed-api:latest`. If running on Linux, use `pnpm run docker:build` otherwise - use `pnpm run docker:build:amd64`. -5. `docker tag api3/signed-api:latest api3/signed-api:` - Tag the image with the version. Replace the - `` with the version you just bumped (copy it from `package.json`). -6. `docker push api3/signed-api:latest && docker push api3/signed-api:` - Push the image upstream. - Both the latest and the versioned tag should be published. -7. `git push --follow-tags` - Push the tagged commit upstream. - ## Deployment To deploy signed API on AWS you can use a CloudFormation template in the `deployment` folder. You need to specify the diff --git a/packages/signed-api/config/signed-api.example.json b/packages/signed-api/config/signed-api.example.json index d4cfa9af..e90c3743 100644 --- a/packages/signed-api/config/signed-api.example.json +++ b/packages/signed-api/config/signed-api.example.json @@ -15,5 +15,5 @@ { "address": "0xbF3137b0a7574563a23a8fC8badC6537F98197CC", "authTokens": ["some-secret-token-for-airnode-feed"] } ], "stage": "local", - "version": "2.4.0" + "version": "0.1.0" } diff --git a/packages/signed-api/package.json b/packages/signed-api/package.json index 7644999a..9462f0c0 100644 --- a/packages/signed-api/package.json +++ b/packages/signed-api/package.json @@ -1,6 +1,6 @@ { "name": "@api3/signed-api", - "version": "2.4.0", + "version": "0.1.0", "engines": { "node": ">=18.19.0", "pnpm": "^8.12.0"