Skip to content

Commit

Permalink
format all docs and workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
smac89 committed Nov 21, 2023
1 parent 84fda7c commit 9d4c742
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 14 deletions.
13 changes: 8 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@

<h2 style="color: green; font-weight: bold">DO</h2>

- **Checkout a release branch corresponding to the version you want to contribute to**
- **Checkout a release branch corresponding to the version you want to
contribute to**
- **Make your changes and create a pull request for that branch**
- **Your request will be merged to master once it is reviewed**

---

## Development
-
```bash

- ```bash
yarn install
yarn test
```
Expand All @@ -23,6 +25,7 @@
- Ping maintainer (@smac89) when PR is ready

## Maintainer Release Notes (shield your eyes :eyes:)

- Merge changes into the respective release branch
- Make other changes if necessary
- If this warrants a new release, then do the following
Expand All @@ -34,9 +37,9 @@
- Merge release branch (`release/vX`) back into `master`
- Append `-latest` to the version in `package.json` on `master`


## License

By contributing, you agree that your contributions will be licensed under its MIT License.
By contributing, you agree that your contributions will be licensed under its
MIT License.

### Thank you for reading
8 changes: 4 additions & 4 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
version: 2
updates:
- package-ecosystem: npm
directory: "/"
directory: '/'
schedule:
interval: weekly
allow:
- dependency-type: "production"
- dependency-type: 'production'
commit-message:
prefix: "chore"
include: "scope"
prefix: 'chore'
include: 'scope'
2 changes: 1 addition & 1 deletion .github/workflows/versioning.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: "Tag latest release of action tagger :zap:"
name: 'Tag latest release of action tagger :zap:'

on:
release:
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,16 +99,22 @@ jobs:
with:
publish_latest_tag: true
```
---
### Notes
1. Add the push configuration if you want this action to also run when a new tag or branch is created.
1. Add the push configuration if you want this action to also run when a new tag
or branch is created.
**An event will
[not be created](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push)
when more than three tags are pushed at once.**
**An event will [not be created](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push) when more than three tags are pushed at once.**
If you want to track branches, swap the filters listed under
`branches-ignore` and `tags-ignore`. At all times, leave the filter for
`paths-ignore` as is.

If you want to track branches, swap the filters listed under `branches-ignore`
and `tags-ignore`. At all times, leave the filter for `paths-ignore` as is.
2. The
[`permissions`](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions)
option is only required if the workflow permission for the given repository
Expand Down

0 comments on commit 9d4c742

Please sign in to comment.