perf(semantic-release): added semantic release CI

Se-Gl · Se-Gl · commit 7aad18ee1fde · 2022-07-22T20:49:27.000+02:00
diff --git a/.github/contributing.md b/.github/contributing.md
@@ -0,0 +1,67 @@
+# Contributing to Transcriptase
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## We Develop with Github
+
+We use github to host code, to track issues and feature requests, as well as accept pull requests.
+
+## We Use [Semantic Release](https://github.com/semantic-release/semantic-release)
+
+We use semantic versioning for commit messages.
+
+For commit messages, use semantig writing:
+
+| Commit                                             |      Usage       | Version |
+| -------------------------------------------------- | :--------------: | ------- |
+| fix(your-change): a small change, maybe just a fix |   Fix Release    | v.0.0.1 |
+| feat(your-change): a new feature, a medium change  | Feature Release  | v.0.1.0 |
+| perf(your-change): a breaking change or hotfix     | Breaking Release | v.1.0.0 |
+
+## We Use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests
+
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs or added new dependencies, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. Use semantic versioning for commits.
+7. Issue a pull request!
+
+## Any contributions you make will be under the MIT Software License
+
+In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using Github's [issues](https://github.com/Se-Gl/greenCSS-frontend/issues)
+
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
+
+## Write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can
+- What you expected would happen
+- What actually happens
+- Notes, Screenshots
+
+People _love_ thorough bug reports. I'm not even kidding.
+
+## Use a Consistent Coding Style
+
+- You can try running `npm run lint` and `npm run prettier` for style unification
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its MIT License.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,19 @@
+# Title
+
+## TL;DR
+
+- Add
+- Things
+- That
+- Happened
+
+## Details
+
+TODO:
+
+- [ ] N/A
+
+Checklist / Reminders:
+
+- [ ] Documentation is created / adapted
+- [ ] Cypress Tests
diff --git a/.github/workflows/prettier.yml b/.github/workflows/prettier.yml
@@ -0,0 +1,18 @@
+name: Styling
+
+# Triggers the eslint workflow on push and pull request events
+on: [push, pull_request]
+
+jobs:
+  ESLint:
+    name: Prettier run and fix
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+      - name: Install npm dependencies
+        run: npm install --force
+      - name: Check files
+        run: npm run prettier:check
+      - name: Write files
+        run: npm run prettier:format
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,33 @@
+name: Release
+
+on:
+  push:
+    branches: [main, beta]
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16.x
+      - name: Install dependencies
+        run: npm install --force
+      - name: Install semantic-release extra plugins
+        run: npm install --save-dev @semantic-release/changelog @semantic-release/git
+      - name: Prettier format
+        run: npm run prettier:format
+      - name: Prettier check
+        run: npm run prettier:check
+      - name: Build
+        run: npm run build
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release
diff --git a/.gitignore b/.gitignore
@@ -31,5 +31,4 @@ yarn-error.log*
 # random
 .vercel
 .next
-.github
-.husky
+
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit $1
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run pre-commit && npm run success-message
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
 # SSR Modal Component
 
-[![Prettier](https://github.com/Se-Gl/modal-react/actions/workflows/prettier.yml/badge.svg)](https://github.com/Se-Gl/modal-react/actions/workflows/prettier.yml)
-[![Downloads p/week](https://badgen.net/npm/dw/modal-react)](https://badgen.net/npm/dw/modal-react)
-[![NPM version](https://badgen.net/npm/v/modal-react)](https://badgen.net/npm/v/modal-react)
-[![minified + gzip](https://badgen.net/bundlephobia/minzip/modal-react)](https://badgen.net/bundlephobia/minzip/modal-react)
-[![License](https://badgen.net/npm/license/modal-react)](https://badgen.net/npm/license/modal-react)
+[![Prettier](https://github.com/Se-Gl/next-modal/actions/workflows/prettier.yml/badge.svg)](https://github.com/Se-Gl/next-modal/actions/workflows/prettier.yml)
+[![Downloads p/week](https://badgen.net/npm/dw/next-modal)](https://badgen.net/npm/dw/next-modal)
+[![NPM version](https://badgen.net/npm/v/next-modal)](https://badgen.net/npm/v/next-modal)
+[![minified + gzip](https://badgen.net/bundlephobia/minzip/next-modal)](https://badgen.net/bundlephobia/minzip/next-modal)
+[![License](https://badgen.net/npm/license/next-modal)](https://badgen.net/npm/license/next-modal)
 
 This is a sustainable React modal component project based on [greenCSS](https://github.com/Se-Gl/greenCSS), which also works SSR with Next.js. greenCSS is an animated, responsive, lightweight and sustainable CSS library. It is recommended that you also use greenCSS in your project. If you don't want to, just style your modal with your own classes.
 
@@ -25,7 +25,7 @@ This is a sustainable React modal component project based on [greenCSS](https://
 First, install the Modal dependency:
 
 ```bash
-npm i modal-react
+npm i next-modal
 ```
 
 ### Next.js
@@ -64,7 +64,7 @@ The following jsx file is based on greenCSS. If you don't want to use it, you ca
 
 ```js
 import React, { useState } from 'react'
-import { Modal } from 'modal-react'
+import { Modal } from 'next-modal'
 
 export default function Home() {
   const [toggleModal, setToggleModal] = useState(false)
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional']
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/release.config.js b/release.config.js

-Original file line number
+Diff line change
 # random
 .vercel
 .next
 -.github
 -.husky
++
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ extends: ['@commitlint/config-conventional']`
	`3`	`+}`