Commit Graph

52 Commits

Author SHA1 Message Date
silverwind
92c8874170 Update README.md 2023-09-08 11:46:17 +02:00
silverwind
c3a152eec1 Add note regarding pull_request_target to README.md
I think this is a big gotcha that should be called out in the documentation. I've been trying to debug why the workflow did not run for a long time, until I finally understood the underlying issue.
2023-09-08 11:43:56 +02:00
임성호
c3a5749d46 Fix readme (#630) 2023-07-31 14:40:58 +02:00
MaksimZhukov
e482ff4263 Update the README (#612)
* Update the README

* Remove extra spaces

* Remove extra space
2023-07-11 14:59:31 +02:00
Liam Stanley
994304c5d5 feat(config): support reading from local file if it exists (#394)
* feat(config): support reading from local file if it exists

Signed-off-by: Liam Stanley <me@liamstanley.io>

* fix: fix review point, update logic

* docs: update readme

* docs: update readme

* feat: add additional logging

* chore: update licenses

* docs: fix review point in readme.md

---------

Signed-off-by: Liam Stanley <me@liamstanley.io>
Co-authored-by: IvanZosimov <ivanzosimov@github.com>
2023-07-07 12:44:54 +02:00
Mark Ridgwell
327d35fdca Added ability to pass in an optional PR number as a parameter (#349)
* Adding pr-number as an optional parameter

* Updated README

* Tests on the pr-number parameter

* Added missing | to table

* re-built script

* Adding support for multiple pr-numbers

* excluded .idea

* Updated readme to reflect that there might be more than one PR

* Additional warning

* Removed unused

* Reformatted and re-built

* Corrected message

* Removed required check

* Added (s) to pull request numbers in the description

Co-authored-by: MaksimZhukov <46996400+MaksimZhukov@users.noreply.github.com>

* Reworded PR-number parameter description

Co-authored-by: MaksimZhukov <46996400+MaksimZhukov@users.noreply.github.com>

* adding getMultilineInput into the tests

* Fixing tests for single pr

* Fixing tests for multiple prs

* Updated README.md to make it more obvious that it can take a list of PRs

* Added example that labels PR's 1-3

* Handled no pull requests better (from code review)

* Handled no pull requests better (from code review)

* Handled missing pull request better (from code review)

* Back out suggested change as it broke the tests

* Rebuilt dist

* Update src/labeler.ts

Co-authored-by: MaksimZhukov <46996400+MaksimZhukov@users.noreply.github.com>

* Added Emphasis to the note

Co-authored-by: MaksimZhukov <46996400+MaksimZhukov@users.noreply.github.com>

* Changed mockInput for pr-number to be string[]

---------

Co-authored-by: MaksimZhukov <46996400+MaksimZhukov@users.noreply.github.com>
2023-07-06 17:10:50 +02:00
MaksimZhukov
65f306b6dd Fix a typo in the example about using the action outputs (#606) 2023-07-05 11:21:49 +02:00
MaksimZhukov
a212485147 Add examples to match all repo files (#600) 2023-06-30 15:44:16 +02:00
Daniel Shteremberg
0967ca812e Added output (#60)
* Added output

* removed formatting changes

* more formatting changes

* Fix merge conflicts

* Small test refactoring

* tests are passing

* Add a test

* Add a small jest mock for addLabels. Not used.

* Add tests for more cases

* get rid of an unused jest mock

* fix review points

* rebuild + minor README fix

* fix review points

* update tests

* fix formatting

* add tests, fix bug

* cleanup

---------

Co-authored-by: Daniel Shteremberg <dshteremberg@labelbox.com>
Co-authored-by: Daniel Shteremberg <Daniel@Daniel-Shterembergs-MacBook-Pro.local>
Co-authored-by: Patrick Ellis <patrick.j.ellis@gmail.com>
Co-authored-by: Andrey Lobanovich <andrei.lobanovich@akvelon.com>
2023-06-29 12:45:24 +02:00
Josh Soref
3240e3059a Markdown: backticks 2023-06-13 13:21:58 -04:00
Josh Soref
1a5defcb60 spelling: e.g. 2023-06-13 13:19:04 -04:00
Dan Fandrich
092c82e551 Document permissions needed for pull_request events
An "Error: HttpError: Resource not accessible by integration" will be
encountered on pull requests with the wrong permissions.

Co-authored-by: AndreiLobanovich
2023-06-07 16:17:26 -07:00
Alexander Kachkaev
d40596e5db micromatch → minimatch 2023-06-02 16:06:39 +01:00
Alexander Kachkaev
4a96e771de Merge branch 'main' into dot-option 2023-03-12 22:13:26 +00:00
Michaël De Boey
ba790c862c feat: default repo-token to github.token (#227)
* feat: default `repo-token` to `github.token`

* Update README.md

* Update labeler.ts

* Update index.js

* Update action.yml

* Update dist/index.js

* Update index.js

* Update dist/index.js
2023-03-07 12:25:56 +01:00
Ivan
8e3e86e548 Update workflow badges (#495) 2023-01-31 08:47:18 +02:00
Alexander Kachkaev
866eff55a5 Merge remote-tracking branch 'origin/main' into dot-option 2023-01-16 17:36:24 +00:00
Jongwoo Han
a11f1c4163 Replace workflow badge with new badge (#476) 2023-01-05 10:44:32 +01:00
Lukas Hennies
f7b1827ed3 docs: minor hint regarding glob notation (#285) 2022-12-21 15:59:36 +01:00
MaksimZhukov
34b1b365e1 Merge pull request #278 from jsoref/fix-at-example
Fix @ example
2022-12-20 10:25:28 +01:00
Alexander Kachkaev
20251547f9 Simplify glob 2022-10-05 14:37:24 +01:00
Alexander Kachkaev
d89797c51d Merge remote-tracking branch 'upstream/main' into dot-option 2022-09-14 14:54:45 +01:00
Patrick Ellis
6a315d4ea5 Merge pull request #314 from jamietanna/patch-1
Clarify `permissions` required to use Action
2022-03-16 11:24:09 -04:00
Thomas Boop
abae52fa24 Update to new v4 release 2022-03-01 12:12:44 -05:00
Alexander Kachkaev
f3632d3e9f Update README.md 2022-02-04 14:47:58 +00:00
Alexander Kachkaev
e05b7c1927 Update README.md 2022-02-04 14:45:39 +00:00
Alexander Kachkaev
8b8677b4ce Improve warning 2022-02-04 13:54:21 +00:00
Alexander Kachkaev
920e9b6169 Add comments 2022-02-04 13:47:52 +00:00
Alexander Kachkaev
b0d9292064 Implement dot option 2022-02-04 13:26:54 +00:00
Jamie Tanna
c8a666accc Clarify permissions required to use Action
As a means to reduce the privileges provided to the job executing, we
can document what the minimal `permissions` required for the Actions'
`GITHUB_TOKEN` is.
2022-02-02 15:43:53 +00:00
Muhammed Rahif
c35a9a27a3 docs(readme): specified 'yml' syntax highlighting
specified 'yml' syntax highlighting for a code block example in readme
2021-12-18 14:24:46 +05:30
Josh Soref
c79c655b8b Fix @ example 2021-11-23 20:57:39 -05:00
Giso Bartels
1d0cef002c Fix documentation for root file changes (#133)
Co-authored-by: Patrick Ellis <patrick.j.ellis@gmail.com>
2021-06-21 17:42:43 -04:00
Patrick Ellis
5400315400 Update README.md
Fix a small html typo.
2021-06-14 18:46:42 -04:00
Patrick Ellis
f6dc3df7ab Update README.md
Add dependency badge
2021-06-11 18:51:17 -04:00
Patrick Ellis
63f27e3a01 Merge pull request #138 from pllim/patch-1
DOC: Example to use released version
2021-06-04 17:00:50 -04:00
Patrick Ellis
ffa3fbeb8f 🧹 Update documentation (#147)
- Document the release process in `CONTRIBUTING.md`
- Add development instructions to `CONTRIBUTING.md` (adapted from [download-artifact](https://github.com/actions/download-artifact))
- Add a test badge to the `README`
- Link to `CONTRIBUTING.md` in `README`
- Unify copy between `README.md` and `action.yml`
- Copy-pasta the CoC from [download-artifact](https://github.com/actions/download-artifact)
2021-06-03 12:43:19 -04:00
Patrick Ellis
bc80d164ed Two minor fixes to the README (#80) (#146)
* Use consistent indentation style in YAML examples
* Fix typo 'indvidual'
2021-06-03 12:39:48 -04:00
P. L. Lim
1b79008a03 DOC: Example to use released version 2021-04-22 15:06:22 -04:00
David Kale
bab130482f Update README.md 2020-09-08 14:49:21 -04:00
ylemkimon
c45f41c777 Update README to use pull_request_target event (#90) 2020-09-08 14:33:55 -04:00
Jameel Al-Aziz
4b52aec09b Add support for exclusions (#22)
* Add support for exclusions

Paths can be negated to stop searching through the remaining patterns in
a the glob list. All changed files tested and at least one matching file
will result in a label being added.

Fixes actions/labeler#9

* Add support for "AND"-ed matches

A new "rich" matcher object can be provided instead of a normal glob.

The matcher object has two fields that accept an array of globs:
* Globs in "all" must all match every changed file.
* Globs in "some" must all match at least one changed file.

Combined with negated globs, this allows for a precise control of when
labels are applied.

* Rename `some` to `any`

* Update README
2020-06-01 17:01:37 -04:00
Edward Thomson
05785e27d6 README: tweak documentation on token permissions 2020-02-05 17:30:53 +00:00
Josh Goebel
2b75d22987 Explain this action fails for fork/PR model
Resolves #12 via documentation.
2020-02-05 17:27:39 +00:00
Callum Silcock
00584cab2c Reworded readme with clearer examples
* Reformatted readme into headings with some basic rewording
* Added basic and common examples
Resolves #24
2019-09-26 16:53:38 +01:00
Paige Bystrom
df04112348 Updating readme for more guidance (#21)
* updating readme

* updating file path
2019-09-12 13:42:28 -04:00
Shawn Napora
44767181ec Add clarity on GITHUB_TOKEN purpose (#19) 2019-09-09 15:53:57 -04:00
Danny McCormick
0d3cd1e1fd Revert readme changes 2019-08-29 09:59:11 -04:00
Danny McCormick
375fca6b78 Use cron triggers 2019-08-28 10:10:14 -04:00
Jonas Faber
989d3858d8 Fix typo in README.md (#5)
Based on this resource: https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events
2019-08-23 10:24:10 -04:00