Skip to content
This repository has been archived by the owner on Nov 6, 2023. It is now read-only.

Commit

Permalink
chore: use vercel instead of versioning node_modules
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Park committed May 11, 2022
1 parent 0558e54 commit a2a603c
Show file tree
Hide file tree
Showing 14 changed files with 9,462 additions and 60 deletions.
4 changes: 4 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ jobs:
name: Running linters
command: npm run lint

- run:
name: Building with ncc
command: npm run build

- run:
name: Running unit tests
command: npm test
8 changes: 1 addition & 7 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module.exports = {
extends: ['@readme/eslint-config'],
plugins: ['node', 'import'],
root: true,
ignorePatterns: [],
ignorePatterns: ['node_modules', 'dist'],
rules: {
'import/extensions': [
'error',
Expand All @@ -25,12 +25,6 @@ module.exports = {
},
settings: {
'require-await': 'error',
'import/resolver': {
alias: {
map: [['@src', './src']],
extensions: ['.js'],
},
},
},
env: {
jest: true,
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ typings/

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
Expand Down
19 changes: 1 addition & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,24 +43,6 @@ If you work at ReadMe: In order to use this as a GitHub Action this repo must be

If you don't: While this might be a handy template for other Heroku customers, it's written specific to ReadMe's needs.

### node_modules

The `node_modules` directory must be checked in to the repo in order to use this GitHub Action without a separate install step.

Before committing changes to the `node_modules` directory, please prune dev dependencies from your local install. Example:

```bash
# Remove dev dependencies from your local node_modules directory
$ npm prune --production
# Commit your changes to package.json and node_modules
$ git add node_modules package.json package-lock.json
$ git commit -m "chore: update node_modules"
# Reinstall all modules, including dev dependencies
$ npm install
```


## Development

Expand All @@ -75,3 +57,4 @@ $ npm install

* `npm run lint`
* `npm test`
* `npm build` (to rebuild `dist/index.js`, otherwise your changes won't be reflected in the copy that actually runs on GitHub!)
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ outputs:
description: "A comment which can be posted to the pull request after the action finishes."
runs:
using: 'node16'
main: 'index.js'
main: 'dist/index.js'
Loading

0 comments on commit a2a603c

Please sign in to comment.