ci: release as github actions (#162)

* ci: release as github actions

* fix: tag version

* ci: update release management

* fix: docs

Author: fmenezes

.github/CONTRIBUTING.md

@@ -7,41 +7,42 @@ on:
         description: 'Version to increment (major, minor or patch)'
         required: true
         default: 'patch'
-
+permissions:
+  contents: write
 jobs:
-  npm:
+  version:
     runs-on: ubuntu-latest
     env:
       VERSION: ${{ github.event.inputs.version }}
+    outputs:
+      tag: ${{ steps.get-tag.outputs.TAG }}
     steps:
     - run: |
         if [[ "$VERSION" != "major" ]] && [[ "$VERSION" != "minor" ]] && [[ "$VERSION" != "patch" ]]; then
           echo "Input should be either 'major', 'minor' or 'patch'"
           exit 1
         fi
     - run: |
-        git config --global user.name "${{ secrets.GIT_USER_NAME }}"
-        git config --global user.email "${{ secrets.GIT_USER_EMAIL }}"
+        git config --global user.name "github-actions[bot]"
+        git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
     - uses: actions/[email protected]
       with:
         node-version-file: package.json
+        registry-url: "https://registry.npmjs.org"
     - run: npm ci
-    - run: npm version $VERSION
-    - name: NPM Publish
-      uses: JS-DevTools/npm-publish@v3
-      with:
-        token: ${{ secrets.NPM_TOKEN }}
-    - run: |
-        echo "TAG=$(npm run env | grep npm_package_version | cut -d '=' -f 2)" >> $GITHUB_ENV
+    - run: npm run check
+    - run: npm version $VERSION --no-git-tag-version
+    - id: get-tag
+      run: |
+        echo "TAG=$(jq -r '.version' < package.json)" >> $GITHUB_OUTPUT
     - name: Create Github Release
-      uses: actions/create-release@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        tag_name: refs/tags/${{ env.TAG }}
-        release_name: Version ${{ env.TAG }}
-        body: Version ${{ env.TAG }}
-
+        GH_TOKEN: ${{ github.token }}
+      run: |
+        gh release create "${{ steps.get-tag.outputs.TAG }}" --title "Version ${{ needs.version.outputs.TAG }}" --generate-notes --target "${{ github.ref }}"
+    - run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/version.yml

@@ -1 +1,2 @@
-tag-version-prefix=""
+tag-version-prefix=
+git-tag-version=false

.npmrc

@@ -0,0 +1,46 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue before making a change. 
+
+Please note we have a [code of conduct](/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+## Development Setup
+
+1. Fork and clone the repository
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Build the project:
+   ```bash
+   npm run build
+   ```
+
+## Testing
+
+Run the test suite before submitting any changes:
+
+```bash
+npm test
+```
+
+The project uses Jest for testing. You can find test files in the `test/` directory.
+
+## Commit Message Guidelines
+
+Please follow these guidelines for commit messages:
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+## Pull Request Process
+
+1. Ensure your code passes on all tests/checks.
+2. Update the README.md with details of changes to the API interface.
+3. Only admins will merge the Pull Request.
+
+## Release Process
+
+Releases are managed by project maintainers and follow semantic versioning (MAJOR.MINOR.PATCH).