[DOCS] Add publishing instructions

begedin · Oct 29, 2022 · 8017813 · 8017813
1 parent b495f1c
commit 8017813
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 # 0.12.1
 
 - [FIX] Publish JS
+- [DOCS] Add publishing instructions
 
 Previous version didn't incoude prebuilt js and types
 

diff --git a/additional_docs/instructions_publish.md b/additional_docs/instructions_publish.md
@@ -0,0 +1,14 @@
+# Publishing a new version
+
+1. Ensure the version number in the following files is correct
+
+- `README.md`
+- `mix.exs`
+- `package.json`
+
+2. Ensure conversion between current and new version works
+3. Run `npm run build` to update the prebuilt .js and declared type
+4. Commit
+5. Create new tag on Github
+6. Run `mix hex.publish`
+7. Run `npm publish`