Add CHANGELOG and github action for releasing

.github/workflows/release-and-publish.yaml

@@ -0,0 +1,93 @@
+name: Release and publish
+
+on:
+  workflow_dispatch:
+    inputs:
+      release-type:
+        description: |
+          Release type (one of): patch, minor, major, prepatch, preminor, premajor, prerelease.  
+          Use prepatch, preminor, premajor for the first "pre", to increment pre value use prerelease.
+        required: true
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "16.x"
+          registry-url: "https://registry.npmjs.org"
+          scope: "@valkyrie-fnd"
+      # Configure Git
+      - name: Git configuration
+        run: |
+          git config --global user.name "${GITHUB_ACTOR}"
+          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+      - run: yarn
+      - run: yarn build
+      # Bump package version
+      # Use tag latest
+      - name: Bump release version
+        if: startsWith(github.event.inputs.release-type, 'pre') != true
+        run: |
+          echo "NEW_VERSION=$(npm version --no-git-tag-version $RELEASE_TYPE)" >> $GITHUB_ENV
+          echo "RELEASE_TAG=latest" >> $GITHUB_ENV
+        env:
+          RELEASE_TYPE: ${{ github.event.inputs.release-type }}
+      # Bump package pre-release version
+      # Use tag beta for pre-release versions
+      - name: Bump pre-release version
+        if: startsWith(github.event.inputs.release-type, 'pre')
+        run: |
+          echo "NEW_VERSION=$(npm version --no-git-tag-version --preid=beta $RELEASE_TYPE
+          echo "RELEASE_TAG=beta" >> $GITHUB_ENV
+        env:
+          RELEASE_TYPE: ${{ github.event.inputs.release-type }}
+
+      # Update changelog unreleased section with new version
+      - name: Update changelog
+        uses: superfaceai/release-changelog-action@v1
+        with:
+          path-to-changelog: CHANGELOG.md
+          version: ${{ env.NEW_VERSION }}
+          operation: release
+
+      # Commit changes
+      - name: Commit CHANGELOG.md and package.json changes and create tag
+        run: |
+          git add "package.json"
+          git add "CHANGELOG.md"
+          git commit -m "chore: release ${{ env.NEW_VERSION }}"
+          git tag ${{ env.NEW_VERSION }}
+
+      # Publish version to public repository
+      - name: Publish
+        run: yarn npm publish --access public --tag ${{ env.RELEASE_TAG }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPMJS_ACCESS_TOKEN }}
+
+      # Push repository changes
+      - name: Push changes to repository
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git push origin && git push --tags
+
+      # Read version changelog
+      - id: get-changelog
+        name: Get version changelog
+        uses: superfaceai/release-changelog-action@v1
+        with:
+          path-to-changelog: CHANGELOG.md
+          version: ${{ env.NEW_VERSION }}
+          operation: read
+
+      # Update GitHub release with changelog
+      - name: Update GitHub release documentation
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: ${{ env.NEW_VERSION }}
+          body: ${{ steps.get-changelog.outputs.changelog }}
+          prerelease: ${{ startsWith(github.event.inputs.release-type, 'pre') }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Changelog
+- Initial commit
+- Github action

README.md

@@ -36,19 +36,6 @@ TBW
 ## Events
 TBW
 
-### Publishing
+## Publishing
 
-Increment the package version (major | minor | patch | ... | prerelease), 
-for more info, see `yarn help version`
-This will tag and commit the incremented version in git.
-
-```shell
-yarn version --prerelease
-```
-
-Publish the package to npm repository. This requires that you've logged in using `yarn login` and that your npm user has access 
-to the valkyrie-fnd organization.
-
-```shell
-yarn publish
-```
+Update [CHANGELOG](./CHANGELOG.md) and then use Release workflow to release and publish a new version

package.json

@@ -27,5 +27,6 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/valkyrie-fnd/valkyrie-event-adapter.git"
-  }
+  },
+  "packageManager": "yarn@3.3.0"
 }

yarn.lock

@@ -5,9 +5,9 @@ __metadata:
   version: 6
   cacheKey: 8
 
-"@valkyrie-fnd/valkyrie-js-event-adapter@workspace:.":
+"@valkyrie-fnd/valkyrie-event-adapter@workspace:.":
   version: 0.0.0-use.local
-  resolution: "@valkyrie-fnd/valkyrie-js-event-adapter@workspace:."
+  resolution: "@valkyrie-fnd/valkyrie-event-adapter@workspace:."
   dependencies:
     typescript: ^4.9.3
   languageName: unknown