|
| 1 | +## Release Documentation |
| 2 | + |
| 3 | +The following will cover releasing the `asset-transfer-api-registry` to both github and NPM. |
| 4 | + |
| 5 | +### Creating the Release Branch |
| 6 | + |
| 7 | +1. Ensure you are in the `main` branch then run: |
| 8 | + |
| 9 | + ```bash |
| 10 | + $ git pull origin main |
| 11 | + $ git checkout -b <name>-vXX-XX-XX |
| 12 | + ``` |
| 13 | + |
| 14 | +1. In your new release branch update the version inside of the `package.json` to match the version we are releasing. This is super important as it will be the source of truth for updating to NPM. |
| 15 | + |
| 16 | +1. Inside of the `CHANGELOG.md`, follow the previous format of other releases, and input each commit that is being added in this current release. |
| 17 | + - Note: For multiple chore: update registry commits, you can just mention one representative entry (similar to how it was done in `v0.3.0`release), rather than listing every individual registry update. |
| 18 | + |
| 19 | +1. Run: |
| 20 | + |
| 21 | + ```bash |
| 22 | + $ git add . |
| 23 | + $ git commit -m 'chore(release): vXX.XX.XX' |
| 24 | + $ git push |
| 25 | + ``` |
| 26 | + |
| 27 | + Then create a PR with the same title as the commit message. |
| 28 | + |
| 29 | +1. When approved merge the PR into main. |
| 30 | + |
| 31 | +### Creating the NPM release |
| 32 | + |
| 33 | +#### Requirements |
| 34 | + |
| 35 | +- You must be part of the integrations NPM team for substrate. |
| 36 | +- You must have 2FA enabled. |
| 37 | + |
| 38 | +#### Steps |
| 39 | + |
| 40 | +1. Ensure your current working branch is `main`, and run the following as a sanity check. |
| 41 | + |
| 42 | + ```bash |
| 43 | + $ git pull origin main |
| 44 | + $ yarn build |
| 45 | + $ yarn test |
| 46 | + ``` |
| 47 | + |
| 48 | +1. Run: |
| 49 | + |
| 50 | + ```bash |
| 51 | + $ yarn deploy |
| 52 | + ``` |
| 53 | + |
| 54 | + #### Notes |
| 55 | + |
| 56 | + - Ensure the logging provided by NPM says the current version that is going to get released is correct before you enter your OTP. |
| 57 | + - If you are on node version 18 or below, it will ask you for your OTP in the terminal. But if you are on node 20 or greater it will redirect you to the browser to input the OTP. |
| 58 | + |
| 59 | +1. Tada! You should have now received a message saying that the package has been released. You can go to https://www.npmjs.com/package/@substrate/asset-transfer-api-registry to double check the release's success. |
| 60 | +
|
| 61 | +### Creating a Github release |
| 62 | +
|
| 63 | +1. Right after you have released the NPM package, we are going to set a tag that will match the version of the release: |
| 64 | +
|
| 65 | + ```bash |
| 66 | + $ git tag vXX.XX.XX |
| 67 | + $ git push origin vXX.XX.XX |
| 68 | + ``` |
| 69 | +
|
| 70 | +1. Once that is pushed to github, go to https://github.com/paritytech/asset-transfer-api-registry/tags, and in the tab where the new version has now been created, click on the 2 dots all the way to the right, and press `create release`. |
| 71 | +
|
| 72 | +1. Inside of `create release` you may copy the contents of the `CHANGELOG.md` for the release and input them there. For the title, just name it the version `vXX.XX.XX`. |
| 73 | +
|
| 74 | +1. Click `Publish as latest`, and that will complete the release process. |
0 commit comments