refactor: refine documentation and configuration

.eslintrc.yaml

@@ -13,6 +13,6 @@ overrides:
       max-lines-per-function: off
       no-magic-numbers: off
 parserOptions:
-  ecmaVersion: 10
+  ecmaVersion: 2020
   project: tsconfig.json
   sourceType: module

.github/ISSUE_TEMPLATE/BUG.md

@@ -11,24 +11,6 @@ Give us short description of the issue, just to understand some context without
 diving too deep into it.
 -->
 
-**What is the name of the function?**
-
-<!--
-If you see issues with a particular function or collection? Let us know here, so
-it's easier to locate the issue.
--->
-
-**Which platforms are affected?**
-
-<!--
-Did you test the behavior on various platforms? It helps us understand how wide
-spread the issue is.
--->
-
-- [ ] Android
-- [ ] iOS
-- [ ] Web
-
 **How can we reproduce the issue?**
 
 <!--

.github/pull_request_template.md

@@ -3,7 +3,6 @@ This Pull Request fulfills the following requirements:
 - [ ] The commit message follows our guidelines.
 - [ ] Tests for the changes have been added if needed.
 - [ ] Does not affect documentation or it has been added or updated.
-- [ ] Does not introduce cycles into the flow of execution.
 
 <!--
 Example: Resolves #1234
@@ -14,7 +13,3 @@ issues.
 -->
 
 Resolves #
-
-<!--
-Link to a PR with a documentation update:
--->

.github/workflows/continuous-deployment.yml

@@ -10,30 +10,35 @@ jobs:
     name: release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - name: Checkout
+        uses: actions/checkout@v1
 
-      - uses: actions/setup-node@v1
+      - name: Setup Node.js with GitHub Package Registry
+        uses: actions/setup-node@v1
         with:
           node-version: 12
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           registry-url: 'https://npm.pkg.github.com'
           scope: 'ridedott'
           always-auth: true
 
-      - uses: actions/setup-node@v1
+      - name: Setup Node.js with npm Package Registry
+        uses: actions/setup-node@v1
         with:
           node-version: 12
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           registry-url: 'https://registry.npmjs.org'
           scope: 'ridedott'
           always-auth: true
 
-      - env:
-          CI: true
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm ci --unsafe-perm
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
 
-      - env:
+      - name: Release
+        env:
           CI: true
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |

.gitignore

@@ -44,8 +44,6 @@ node_modules
 # Coverage output
 coverage
 
-# Include distribution files, as Actions are directly clonned and run.
-!dist/*
-
-# TypeScript Build output
+# Build output
+dist
 lib

.releaserc.yaml

@@ -21,9 +21,9 @@ plugins:
           release: patch
   - '@semantic-release/release-notes-generator'
   - '@semantic-release/changelog'
-  - '@semantic-release/npm'
   - - '@semantic-release/git'
     - assets:
+        - dist
         - package.json
         - package-lock.json
         - CHANGELOG.md

CONTRIBUTING.md

@@ -12,8 +12,8 @@ better than it is today! Here are the guidelines we'd like you to follow:
 
 ## <a name="question"></a> Got a Question or Problem?
 
-If you have questions about how to use this project, please direct these to our
-[Slack Channel](https://ridedott.slack.com/messages/CDYNSCMJB).
+If you have questions about how to use this project, please open an issue on
+GitHub.
 
 ## <a name="issue"></a> Found an Issue?
 
@@ -50,9 +50,9 @@ features, by not reporting duplicate issues.
 Before you submit your merge request consider the following guidelines:
 
 - Search
-  [GitHub repository](https://github.com/ridedott/auto-merge-action/issues) for
-  an open or closed Pull Request that relates to your submission. You don't want
-  to duplicate effort.
+  [GitHub repository](https://github.com/ridedott/dependabot-auto-merge-action/issues)
+  for an open or closed Pull Request that relates to your submission. You don't
+  want to duplicate effort.
 - Make your changes in a new branch:
 
   ```shell

README.md

@@ -4,14 +4,14 @@
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
-Automatically merges Pull Requests.
+Automatically merges Dependabot Pull Requests.
 
 ## Usage
 
-Create a new `.github/workflows/auto-merge.yml` file:
+Create a new `.github/workflows/dependabot-auto-merge.yml` file:
 
 ```yaml
-name: Auto merge
+name: Auto merge Dependabot updates
 
 on:
   check_suite:
@@ -42,7 +42,7 @@ Add a job as a last step of your CI workflow:
 
 ```yaml
 auto-merge:
-  name: Auto merge
+  name: Auto merge Dependabot updates
   runs-on: ubuntu-latest
   needs:
     - all
@@ -82,17 +82,18 @@ Minimal requirements to set up the project:
 Start by cloning the repository:
 
 ```bash
-git clone [email protected]:ridedott/[package-name].git
+git clone [email protected]:ridedott/dependabot-auto-merge-action.git
 ```
 
 In case you don't have a git client, you can get the latest version directly by
-using [this link](https://github.com/ridedott/[package-name]/archive/master.zip)
+using
+[this link](https://github.com/ridedott/dependabot-auto-merge-action/archive/master.zip)
 and extracting the downloaded archive.
 
 Go the the right directory and install dependencies:
 
 ```bash
-cd [package-name]
+cd dependabot-auto-merge-action
 npm install
 ```
 
@@ -123,17 +124,12 @@ npm run lint
 npm run lint:fix
 ```
 
-### Coverage
-
-[Coveralls.io](https://coveralls.io)
-
 ## Publishing
 
 Publishing is handled in an automated way and must not be performed manually.
 
-Each commit to the master branch is automatically deployed to the NPM registry
-with a version specified in `package.json`. All other commits are published as
-pre-releases.
+Each commit to the master branch is automatically tagged using
+[`semantic-release`](https://github.com/semantic-release/semantic-release).
 
 ## Contributing
 
@@ -145,15 +141,13 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 ### Automation
 
-- [GitHub Actions](https://github.com/features/actions)
 - [Dependabot](https://dependabot.com/)
+- [GitHub Actions](https://github.com/features/actions)
 
 ### Source
 
 - [TypeScript](https://www.typescriptlang.org)
 
-### Delivery
-
 ## Versioning
 
 This project adheres to [Semantic Versioning](http://semver.org) v2.