Skip to content

feat: stack visualization in PR comment #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tranhl merged 3 commits into from
Jul 13, 2025
Merged

feat: stack visualization in PR comment #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf62722
feat: stack visualization in pull request comment
tranhl Jul 13, 2025
6b5427a
location adapter factory
tranhl Jul 13, 2025
7b9ace3
revert workflow change
tranhl Jul 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 56 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</picture>
</p>

# Git Town Action V1
# Git Town Action v1

This action visualizes your stacked changes when proposing pull requests on GitHub:

Expand Down Expand Up @@ -96,48 +96,25 @@ be able to use it again to update the visualization:
[ ] Baz
```

## Manual Configuration
## Customization

If you are using Git Town v11 and below, or are setting up the action for a repository
that doesn't have a `.git-branches.toml`, you will need to tell the action what the
main branch and perennial branches are for your repository.
### Visualization Location

### Main Branch
The location of the stack visualization can be customized using the `location` input.
Valid options for this input include:

The main branch is the default parent branch for new feature branches, and can be
specified using the `main-branch` input:
- `description`: This is the default option. The stack visualization will appear within the
pull request description. This will require granting `pull-requests: write` permissions to the
action.
- `comment`: The stack visualization will appear in a separate comment. No additional permissions
are required for this option.

```yaml
- uses: git-town/action@v1
with:
main-branch: 'main'
location: comment
```
The action will default to your repository's default branch, which it fetches via
the GitHub REST API.
### Perennial Branches
Perennial branches are long lived branches and are never shipped.
There are two ways to specify perennial branches: explicitly or via regex. This can
be done with the `perennial-branches` and `perennial-regex` inputs respectively:

```yaml
- uses: git-town/action@v1
with:
perennial-branches: |
dev
staging
prod
perennial-regex: '^release-.*$'
```

Both inputs can be used at the same time. The action will merge the perennial
branches given into a single, de-duplicated list.

## Customization

### Skip Single Stacks
If you don't want the stack visualization to appear on pull requests which are **not** part
Expand All @@ -160,12 +137,12 @@ and closed pull requests. However, this can increase the runtime of the action f
larger/older repositories.

If you're experiencing long runtimes, the `history-limit` input can be configured to
limit the total number of closed pull requests fetched by the action:
limit the total number of pull requests fetched by the action:

```yaml
- uses: git-town/action@v1
with:
history-limit: '500' # Only fetch the latest 500 closed pull requests
history-limit: 500 # Only fetch the latest 500 pull requests
```

> [!WARNING]
Expand Down Expand Up @@ -195,6 +172,46 @@ it into the actions's `github-token` input to grant it sufficient permissions:
github-token: ${{ secrets.GIT_TOWN_PAT }} # 👈 Add this to `git-town.yml`
```

## Manual Configuration

If you are using Git Town v11 and below, or are setting up the action for a repository
that doesn't have a `.git-branches.toml`, you will need to tell the action what the
main branch and perennial branches are for your repository.

### Main Branch

The main branch is the default parent branch for new feature branches, and can be
specified using the `main-branch` input:

```yaml
- uses: git-town/action@v1
with:
main-branch: main
```
The action will default to your repository's default branch, which it fetches via
the GitHub REST API.
### Perennial Branches
Perennial branches are long lived branches and are never shipped.
There are two ways to specify perennial branches: explicitly or via regex. This can
be done with the `perennial-branches` and `perennial-regex` inputs respectively:

```yaml
- uses: git-town/action@v1
with:
perennial-branches: |
dev
staging
prod
perennial-regex: '^release-.*$'
```

Both inputs can be used at the same time. The action will merge the perennial
branches given into a single, de-duplicated list.

## Reference

```yaml
Expand All @@ -211,6 +228,9 @@ inputs:
perennial-regex:
required: false
default: ''
location:
required: false
default: 'description'
skip-single-stacks:
required: false
default: false
Expand All @@ -219,7 +239,6 @@ inputs:
default: '0'
```

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE).
3 changes: 3 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ inputs:
perennial-regex:
required: false
default: ''
location:
required: false
default: 'description'
skip-single-stacks:
required: false
default: false
Expand Down
Loading
Loading