Skip to content

Commit 39db4c5

Browse files
authored
Merge pull request #1 from ProAngular/ct/documentation
Update readme and deploy hooks
2 parents 07d89f6 + 05b6434 commit 39db4c5

9 files changed

+117
-125
lines changed

.github/workflows/on-merge-main.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: "Verify and Deploy"
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
verify_and_deploy:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v3
11+
- name: Checkout 🛎️
12+
run: npm ci
13+
14+
- name: Verify Code 👌
15+
run: |
16+
npm run lint
17+
npm run prettier:check
18+
19+
- name: Build 🔧
20+
run: |
21+
npm run build:prod
22+
npm run npm-build-package
23+
24+
# https://docs.npmjs.com/about-packages-and-modules
25+
- uses: actions/setup-node@v3
26+
- name: Deploy Package to `npmjs` 🚀
27+
with:
28+
registry-url: "https://registry.npmjs.org"
29+
run: npm publish --access public --folder dist/npm
30+
env:
31+
NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
32+
33+
# https://docs.github.com/en/packages
34+
# https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
35+
- uses: actions/setup-node@v3
36+
- name: Deploy Package to `gpr` 🚀
37+
with:
38+
registry-url: "https://npm.pkg.github.com"
39+
run: npm publish --access public --folder dist/npm
40+
env:
41+
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
1-
name: Verify Pull Request
2-
"on": pull_request
1+
name: "Verify Pull Request"
2+
on: pull_request
33
jobs:
4-
build:
4+
verify_pull_request:
55
runs-on: ubuntu-latest
66
steps:
7+
- uses: actions/checkout@v3
78
- name: Checkout 🛎️
8-
uses: actions/checkout@v3
9-
- name: Build Check 🔧
9+
run: npm ci
10+
11+
- name: Verify Code 👌
1012
run: |
11-
npm ci
1213
npm run lint
1314
npm run prettier:check
15+
16+
- name: Build 🔧
17+
run: |
1418
npm run build:prod
19+
npm run npm-build-package

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
# Except these files and directories:
55
!.github/
66
!.husky/
7+
!.scripts/
78
!e2e/src
89
!src/

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
<p align="center">
2+
<img src="src/assets/pro-angular-logo.svg?sanitize=true">
3+
<h1 align="center">Angular Scroll Top Button</h1>
4+
</p>
5+
6+
[![npm version](https://badge.fury.io/js/@proangular%2Fngx-scroll-top.svg)](https://badge.fury.io/js/@proangular%2Fngx-scroll-top)
7+
[![NPM Downloads](https://img.shields.io/amo/dw/@proangular%252Fngx-scroll-top.svg)](https://www.npmjs.com/@proangular/ngx-scroll-top)
8+
[![Join the chat at https://gitter.im/ProAngular/community](https://badges.gitter.im/ProAngular/lobby.svg)](https://gitter.im/ProAngular/community)
9+
110
# ngx-scroll-top
211
Configurable, lightweight back to top button for Angular projects
312

0 commit comments

Comments
 (0)