Compare commits
6 Commits
v35.7.0-se
...
v35.7.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4e680e146a | ||
|
|
c8fb92cb80 | ||
|
|
32a737ef81 | ||
|
|
03d80c561a | ||
|
|
d5cbe0076a | ||
|
|
e3cd18048c |
39
README.md
39
README.md
@@ -17,6 +17,22 @@
|
||||
|
||||
Retrieve all changed files and directories relative to the target branch or the last remote commit returning a **relative path** from the project root.
|
||||
|
||||
## Table of contents
|
||||
|
||||
* [Features](#features)
|
||||
* [Usage](#usage)
|
||||
* [Useful Acronyms](#useful-acronyms)
|
||||
* [Outputs](#outputs)
|
||||
* [Inputs](#inputs)
|
||||
* [Versioning](#versioning)
|
||||
* [Examples](#examples)
|
||||
* [Real world example](#real-world-example)
|
||||
* [Known Limitation](#known-limitation)
|
||||
* [Migration guide](#migration-guide)
|
||||
* [Credits](#credits)
|
||||
* [Report Bugs](#report-bugs)
|
||||
* [Contributors ✨](#contributors-)
|
||||
|
||||
## Features
|
||||
|
||||
* Fast execution (0-10 seconds on average).
|
||||
@@ -208,6 +224,24 @@ Support this project with a :star:
|
||||
|
||||
<!-- AUTO-DOC-INPUT:END -->
|
||||
|
||||
## Versioning
|
||||
|
||||
This GitHub Action follows the principles of [Semantic Versioning](https://semver.org) for versioning releases.
|
||||
|
||||
In addition to the standard versioning scheme, this action also uses the `v[major.minor.patch]-sec` convention for versions that implement hardening security strategies as described in the [GitHub Actions security hardening guide](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions).
|
||||
|
||||
The format of the version string is as follows:
|
||||
|
||||
major: is a major release number that indicates significant changes or new features that may not be backward compatible.
|
||||
minor: is a minor release number that indicates minor changes or new features that are backward compatible.
|
||||
patch : is a patch release number that indicates bug fixes or other small changes that are backward compatible.
|
||||
|
||||
`-sec` is a suffix that indicates a security-hardened version that implements additional security measures.
|
||||
|
||||
For example, `v1.2.3-sec` would indicate a security-hardened version of the action with major version 1, minor version 2, and patch version 3.
|
||||
|
||||
Using this versioning convention helps ensure that users can easily identify and choose security-hardened versions of this action when integrating it into their workflows.
|
||||
|
||||
## Examples
|
||||
|
||||
<details>
|
||||
@@ -691,8 +725,6 @@ See [inputs](#inputs) for more information.
|
||||
|
||||
<img width="1147" alt="Screen Shot 2021-11-19 at 4 59 21 PM" src="https://user-images.githubusercontent.com/17484350/142696936-8b7ca955-7ef9-4d53-9bdf-3e0008e90c3f.png">
|
||||
|
||||
* Free software: [MIT license](LICENSE)
|
||||
|
||||
## Known Limitation
|
||||
|
||||
> NOTE: :warning:
|
||||
@@ -700,6 +732,7 @@ See [inputs](#inputs) for more information.
|
||||
> * Using characters like `\n`, `%`, `.` and `\r` as separators would be [URL encoded](https://www.w3schools.com/tags/ref_urlencode.asp)
|
||||
> * Spaces in file names can introduce bugs when using bash loops. See: [#216](https://github.com/tj-actions/changed-files/issues/216)
|
||||
> However, this action will handle spaces in file names, with a recommendation of using a separator to prevent hidden issues.
|
||||
>
|
||||
> 
|
||||
|
||||
## Migration guide
|
||||
@@ -738,6 +771,8 @@ With the switch from using grep's Extended regex to match files to the natively
|
||||
custom/**
|
||||
```
|
||||
|
||||
* Free software: [MIT license](LICENSE)
|
||||
|
||||
## Credits
|
||||
|
||||
This package was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter).
|
||||
|
||||
@@ -208,7 +208,7 @@ runs:
|
||||
INPUT_FETCH_DEPTH: ${{ inputs.fetch_depth }}
|
||||
INPUT_SINCE_LAST_REMOTE_COMMIT: ${{ inputs.since_last_remote_commit }}
|
||||
- name: Glob match
|
||||
uses: tj-actions/glob@cebfb084cdf62d72c5318b1b3595ac5a45ed022f # renovate: tag=v16.11
|
||||
uses: tj-actions/glob@v16.11
|
||||
id: glob
|
||||
with:
|
||||
files: ${{ inputs.files }}
|
||||
@@ -255,7 +255,7 @@ runs:
|
||||
INPUT_HAS_CUSTOM_PATTERNS: ${{ steps.glob.outputs.has-custom-patterns }}
|
||||
INPUT_JSON_RAW_FORMAT: ${{ inputs.json_raw_format }}
|
||||
- name: Generate output files
|
||||
uses: tj-actions/json2file@ee0fd2ce53e57fa50da61615cd644018eaf3ab6c # renovate: tag=v1.3.0
|
||||
uses: tj-actions/json2file@v1.3.0
|
||||
if: inputs.write_output_files == 'true'
|
||||
with:
|
||||
outputs: ${{ toJSON(steps.changed-files.outputs) }}
|
||||
|
||||
Reference in New Issue
Block a user