Skip to content

Commit

Permalink
Add README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
bradymholt committed Jan 25, 2023
1 parent 151ccc7 commit 2530946
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 1 deletion.
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# US Holiday Action

GitHub Action that determines whether the current system clock date is a US Holiday

## Inputs

### `included_holidays`

**Required** A comma separated list of holiday names to include (from this list: https://github.com/bradymholt/us-holidays-helper/blob/12c6fa7f3e5f64565275a11e39f775177baf2407/src/index.ts#L13-L31)

**Default** `"newYearsDay,martinLutherKingJrDay,presidentsDay,memorialDay,juneteenth,indigenousPeoplesDay,independenceDay,laborDay,thanksgiving,christmas,newYearsEve"`

## Example usage

```yaml
steps:
- uses: ynab/[email protected]
id: us-holiday-check
with:
included_holidays: "newYearsDay,martinLutherKingJrDay,presidentsDay,memorialDay,juneteenth,indigenousPeoplesDay,independenceDay,laborDay,thanksgiving,christmas,newYearsEve"
- run: echo "Today is a US Holiday"
if: steps.us-holiday-check.outputs.is-holiday == 'true'
```
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'US Holiday Action'
description: 'GitHub Action that determines if today (system clock) is a US Holiday'
description: 'GitHub Action that determines whether the current system clock date is a US Holiday'
inputs:
included_holidays:
description: "A comma separated list of holiday names to include (from this list: https://github.com/bradymholt/us-holidays-helper/blob/12c6fa7f3e5f64565275a11e39f775177baf2407/src/index.ts#L13-L31)"
Expand Down

0 comments on commit 2530946

Please sign in to comment.