ci: init

.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      # - name: lint
+      #   run: npm run lint
+      # - run: npm run build
+      # - name: Run test
+      #   run: npm run test:ci
+      # - name: Upload coverage reports to Codecov
+      #   uses: codecov/codecov-action@v4.0.1
+      #   with:
+      #     token: ${{ secrets.CODECOV_TOKEN }}
+      #     slug: rbalet/ngx-back-button
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.ref_name == 'main'
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build
+      - name: release
+        run: cd dist/ngx-back-button && npx semantic-release --branches main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -1,20 +1,15 @@
-# @ngx-back-button [![npm version](https://img.shields.io/npm/v/ngx-back-button.svg)](https://www.npmjs.com/package/ngx-back-button)
+# @ngx-back-button 
 A library for handling a proper angular back button capability
 
+![NPM](https://img.shields.io/npm/l/ngx-back-button)
+[![npm version](https://img.shields.io/npm/v/ngx-back-button.svg)](https://www.npmjs.com/package/ngx-back-button)
+![npm bundle size](https://img.shields.io/bundlephobia/min/ngx-back-button)
+![npm](https://img.shields.io/npm/dm/ngx-back-button)
+
 1. Handle Browser history
 2. Handle `Fallback` when clicking on the back button when not routed yet
 3. Handle custom `Fallback`
 
-- [@ngx-back-button ](#ngx-back-button-)
-  - [Demo](#demo)
-  - [Installation](#installation)
-    - [rootUrl](#rooturl)
-    - [fallbackPrefix](#fallbackprefix)
-  - [Usage](#usage)
-    - [Directive](#directive)
-    - [Service](#service)
-  - [Authors and acknowledgment](#authors-and-acknowledgment)
-
 ## Demo
 - https://stackblitz.com/~/github.com/rbalet/ngx-back-button