Skip to content

Commit

Permalink
chore(release): update doc for release
Browse files Browse the repository at this point in the history
  • Loading branch information
juanigalan91 committed Dec 6, 2020
1 parent a4613f8 commit 06130e2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
6 changes: 5 additions & 1 deletion CHANGE_LOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Change log

## Unreleased
- Added the possibility to ignore certain workspaces from the check dependencies action

## 0.2.2
- Added the possibility to ignore main package json
- Added the possibility to just warn rather than break the CI

## 0.2.1
- Added the possibility to ignore certain workspaces from the check dependencies action

## 0.2.0 (current)
Beta version with the check dependencies action created.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Awesome Github Action to analyse your yarn monorepo!

## Requirements
This Github Action assumes that you are using yarn workspaces in order to manage your monorepo. If your `package.json` has a key called `workspaces` where you confgire where your packages are, then you are good to go!
This Github Action assumes that you are using yarn workspaces in order to manage your monorepo. If your `package.json` has a key called `workspaces` where you configure where your packages are, then you are good to go!

## Functionalities
### Dependencies check
Expand Down Expand Up @@ -37,7 +37,7 @@ steps:
- name: Checkout
uses: actions/checkout@v2
- name: Check dependencies
uses: juanigalan91/[email protected].1
uses: juanigalan91/[email protected].2
with:
# Whether you want to execute the check dependencies action or not
check-dependencies: true
Expand All @@ -52,7 +52,7 @@ steps:
- name: Checkout
uses: actions/checkout@v2
- name: Check dependencies
uses: juanigalan91/[email protected].1
uses: juanigalan91/[email protected].2
with:
check-dependencies: true
ignore-workspaces: 'dev-packages,third-parties' # lists of workspaces to ignore from the check, list of strings separated by a comma
Expand All @@ -67,7 +67,7 @@ steps:
- name: Checkout
uses: actions/checkout@v2
- name: Check dependencies
uses: juanigalan91/[email protected].1
uses: juanigalan91/[email protected].2
with:
check-dependencies: true
include-main-package-json: true
Expand All @@ -82,7 +82,7 @@ steps:
- name: Checkout
uses: actions/checkout@v2
- name: Check dependencies
uses: juanigalan91/[email protected].1
uses: juanigalan91/[email protected].2
with:
check-dependencies: true
only-warn: true
Expand Down

0 comments on commit 06130e2

Please sign in to comment.