Skip to content

Commit 833a498

Browse files
authored
docs: rename gh action (#3)
* docs: rename gh action Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> * notes Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> * sanity Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> * fix default input Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> * gha description Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com> --------- Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>
1 parent a7cb5eb commit 833a498

File tree

4 files changed

+56
-17
lines changed

4 files changed

+56
-17
lines changed

.github/workflows/test_ci.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Test CI
3+
4+
on:
5+
pull_request:
6+
paths: [.github/workflows/test_ci.yaml, action.yml]
7+
8+
jobs:
9+
ci:
10+
runs-on: ubuntu-24.04
11+
12+
permissions:
13+
contents: read # Required to checkout repository.
14+
15+
steps:
16+
- name: Checkout repository
17+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
18+
with:
19+
fetch-depth: 0
20+
persist-credentials: false
21+
22+
- name: Changed diff-tree
23+
id: changed
24+
uses: ./

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
[![GitHub license](https://img.shields.io/github/license/op5dev/diff-tree?logo=apache&label=License)](LICENSE "Apache License 2.0.")
2-
[![GitHub release tag](https://img.shields.io/github/v/release/op5dev/diff-tree?logo=semanticrelease&label=Release)](https://github.com/op5dev/diff-tree/releases "View all releases.")
1+
[![GitHub license](https://img.shields.io/github/license/op5dev/changed-diff-tree?logo=apache&label=License)](LICENSE "Apache License 2.0.")
2+
[![GitHub release tag](https://img.shields.io/github/v/release/op5dev/changed-diff-tree?logo=semanticrelease&label=Release)](https://github.com/op5dev/changed-diff-tree/releases "View all releases.")
33
*
4-
[![GitHub repository stargazers](https://img.shields.io/github/stars/op5dev/diff-tree)](https://github.com/op5dev/diff-tree "Become a stargazer.")
4+
[![GitHub repository stargazers](https://img.shields.io/github/stars/op5dev/changed-diff-tree)](https://github.com/op5dev/changed-diff-tree "Become a stargazer.")
55

6-
# Diff-Tree
6+
# Changed Diff-Tree ±
77

8-
Git diff-tree for a list of changed files or directories between commits for GitHub Action event triggers.
8+
Changed diff-tree for a list of changed files or directories between branches with GitHub Action event triggers
9+
10+
TODO: https://github.com/orgs/community/discussions/25950
911

1012
## Parameters
1113

@@ -33,21 +35,21 @@ View [security policy and reporting instructions](SECURITY.md).
3335

3436
## Changelog
3537

36-
View [all notable changes](https://github.com/op5dev/diff-tree/releases "Releases.") to this project in [Keep a Changelog](https://keepachangelog.com "Keep a Changelog.") format, which adheres to [Semantic Versioning](https://semver.org "Semantic Versioning.").
38+
View [all notable changes](https://github.com/op5dev/changed-diff-tree/releases "Releases.") to this project in [Keep a Changelog](https://keepachangelog.com "Keep a Changelog.") format, which adheres to [Semantic Versioning](https://semver.org "Semantic Versioning.").
3739

3840
> [!TIP]
3941
>
4042
> All forms of **contribution are very welcome** and deeply appreciated for fostering open-source projects.
4143
>
42-
> - [Create a PR](https://github.com/op5dev/diff-tree/pulls "Create a pull request.") to contribute changes you'd like to see.
43-
> - [Raise an issue](https://github.com/op5dev/diff-tree/issues "Raise an issue.") to propose changes or report unexpected behavior.
44-
> - [Open a discussion](https://github.com/op5dev/diff-tree/discussions "Open a discussion.") to discuss broader topics or questions.
45-
> - [Become a stargazer](https://github.com/op5dev/diff-tree/stargazers "Become a stargazer.") if you find this project useful.
44+
> - [Create a PR](https://github.com/op5dev/changed-diff-tree/pulls "Create a pull request.") to contribute changes you'd like to see.
45+
> - [Raise an issue](https://github.com/op5dev/changed-diff-tree/issues "Raise an issue.") to propose changes or report unexpected behavior.
46+
> - [Open a discussion](https://github.com/op5dev/changed-diff-tree/discussions "Open a discussion.") to discuss broader topics or questions.
47+
> - [Become a stargazer](https://github.com/op5dev/changed-diff-tree/stargazers "Become a stargazer.") if you find this project useful.
4648
4749
</br>
4850

4951
## License
5052

5153
- This project is licensed under the permissive [Apache License 2.0](LICENSE "Apache License 2.0.").
52-
- All works herein are my own, shared of my own volition, and [contributors](https://github.com/op5dev/diff-tree/graphs/contributors "Contributors.").
54+
- All works herein are my own, shared of my own volition, and [contributors](https://github.com/op5dev/changed-diff-tree/graphs/contributors "Contributors.").
5355
- Copyright 2016-present [Rishav Dhar](https://github.com/rdhar "Rishav Dhar's GitHub profile.") — All wrongs reserved.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ Integrating security in your CI/CD pipeline is critical to practicing DevSecOps.
1111

1212
## Reporting a Vulnerability
1313

14-
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to <contact@OP5.dev> or reported via [Security Advisory](https://github.com/op5dev/diff-tree/security/advisories/new "Create a new security advisory.").
14+
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to <contact@OP5.dev> or reported via [Security Advisory](https://github.com/op5dev/changed-diff-tree/security/advisories/new "Create a new security advisory.").

action.yml

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
name: Git Diff-Tree for Changed Files or Directories
2+
name: Changed Diff-Tree for Files or Directories
33
author: Rishav Dhar (@rdhar)
4-
description: Git diff-tree for a list of changed files or directories between commits for GitHub Action event triggers.
4+
description: Changed diff-tree for a list of changed files or directories between branches with GitHub Action event triggers.
55

66
runs:
77
using: composite
@@ -28,10 +28,23 @@ outputs:
2828
value: placeholder
2929

3030
inputs:
31+
source_ref:
32+
default: ""
33+
description: "Source branch or commit SHA to compare from."
34+
required: false
35+
target_ref:
36+
default: ""
37+
description: "Target branch or commit SHA to compare against."
38+
required: false
39+
format:
40+
default: "raw"
41+
description: "Format output as: 'raw', 'json', or 'matrix'."
42+
required: false
3143
token:
32-
required: true
44+
default: ${{ github.token }}
3345
description: "GitHub access token with 'read:org' scope (e.g., secrets.CI_PAT)."
46+
required: true
3447

3548
branding:
36-
color: green
37-
icon: user-check
49+
color: gray-dark
50+
icon: file-plus

0 commit comments

Comments
 (0)