Skip to content

Commit

Permalink
Update release guide (#253)
Browse files Browse the repository at this point in the history
* Update release guide

* Update ci.yml (#254)

Removes Java 8, since ELK 0.9.0 no longer supports Java 8.

* add info to create github release before publishing on npm

* update guide

* update release guide with info on how to correctly tag npm versions
  • Loading branch information
Eddykasp authored Jan 8, 2024
1 parent 5b6e18a commit a1f4ab1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
fail-fast: false
matrix:
node-version: [ 14.x, 16.x, 18.x ]
java-version: [ 8, 11, 13, 15, 17 ]
java-version: [ 11, 13, 15, 17 ]

steps:
- uses: actions/checkout@v1
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,15 +335,23 @@ Afterwards you can find the created files in the `lib` folder.
Current procedure
```bash
git checkout -b releases/0.x.x
# Update versions and commit the changes
# Check that the version numbers are correct, if necessary update versions and commit the changes
npm install
npm run build
npm run test
# Add ./lib/ directory and commit
git tag 0.x.x
# Push release branch an tags to remote
npm publish
# Push release branch and tags to remote
# Create a new release on Github for the new tag and afterwards publish to npm
npm publish --tag=latest
```
Afterwards the following version numbers have to be changed to the next release number:
* `version` in `package.json`,
* `melk` in `build.gradle`.

## Incorrect npm tags
Incorrectly tagged versions on npm can be updated with
`npm dist-tag add elkjs@<version> <latest/next>`.

# Links
In the following a list of asorted links to other projects and sites that may prove helpful:
Expand Down

0 comments on commit a1f4ab1

Please sign in to comment.