Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevenjdh/branch-details
A GitHub action that exposes information about branches, tags, and related concepts to simplify automation activities.
https://github.com/stevenjdh/branch-details
actions branches context details information release-automation
Last synced: 29 days ago
JSON representation
A GitHub action that exposes information about branches, tags, and related concepts to simplify automation activities.
- Host: GitHub
- URL: https://github.com/stevenjdh/branch-details
- Owner: StevenJDH
- License: gpl-3.0
- Created: 2024-09-29T14:32:55.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-09T22:00:35.000Z (3 months ago)
- Last Synced: 2024-12-05T12:06:03.810Z (29 days ago)
- Topics: actions, branches, context, details, information, release-automation
- Language: C#
- Homepage:
- Size: 97.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Action: Branch Details
[](https://github.com/StevenJDH/branch-details/actions/workflows/dotnet-action-sonar-container-workflow.yml)
[](https://github.com/search?o=desc&q=StevenJDH+branch-details+language%3AYAML&s=&type=Code)
[](https://app.codacy.com/gh/StevenJDH/branch-details/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://sonarcloud.io/summary/new_code?id=StevenJDH_branch-details)
[](https://sonarcloud.io/summary/new_code?id=StevenJDH_branch-details)
[](https://sonarcloud.io/summary/new_code?id=StevenJDH_branch-details)
[](https://sonarcloud.io/summary/new_code?id=StevenJDH_branch-details)
[](https://sonarcloud.io/dashboard?id=StevenJDH_branch-details)
[](https://sonarcloud.io/summary/new_code?id=StevenJDH_branch-details)
[](https://sonarcloud.io/summary/new_code?id=StevenJDH_branch-details)
[](https://sonarcloud.io/summary/new_code?id=StevenJDH_branch-details)
[](https://sonarcloud.io/summary/new_code?id=StevenJDH_branch-details)
Branch Details is a GitHub action that exposes information about branches, tags, and related concepts to simplify automation activities. It has been compiled to native code using [Ahead-Of-Time (AOT)](https://en.wikipedia.org/wiki/Ahead-of-time_compilation) compilation for increased performance and reduced memory usage. The native code is containerized using an Ubuntu-based [.NET Chiseled Container](https://devblogs.microsoft.com/dotnet/announcing-dotnet-chiseled-containers/) to further reduce the image size while significantly improving security and loading speeds. In fact, the base image is made up of only 6 files, which accounts for less than 10MB of the final image size. Do keep in mind that GitHub [only supports container actions on Linux runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#requirements-for-self-hosted-runner-machines), but as soon as this changes, support will be added.
[](https://www.buymeacoffee.com/stevenjdh)
## Features
* Automatic processing of branch details in a predictable way to simplify workflows.
* Reference outputs for aggregated information associated with a branch.
* Optionally export outputs to environment variables.
* Summary reports are generated after each run.
* When testing locally, GitHub PATs can be auto loaded via [.NET's Secrets Manager](https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-8.0&tabs=windows#secret-manager).
## Compatibility
Below is a list of GitHub-hosted runners that support jobs using this action.
| Runner | Supported? |
|------------|:----------:|
| [](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) | ✅ |
| [](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) | ❌ |
| [](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) | ❌ |
## Inputs
The following inputs are available:
| Name | Type | Required | Default | Description |
|------------------------------------------------------------------------------|----------|:--------:|:-------------------------------:|---------------------------------------------------------------------|
| [drop‑tag‑prefix](#drop-tag-prefix) | `string` | `false` |
| [export‑variables](#export-variables) | `string` | `false` | `false` | Indicates whether or not to set environment variables for each output exposed by this action for other steps in a job. Format is `BD_XXX` with all in uppercase. For example, `triggering_ref` becomes `BD_TRIGGERING_REF`. |
| [github‑token](#github-token) | `string` | `false` | ${{ github.token }} | Overrides the default GitHub token to authenticate API requests. |
## Outputs
The following outputs are available:
| Name | Type | Example(s) | Description |
|----------------------------------------------------------------------|----------|------------|-------------------------------------------------------------------------------------|
| [triggering_ref](#triggering_ref) | `string` | refs/heads/main, refs/pull/123/merge, refs/tags/v1.0.0 | The fully-formed ref of the branch or tag that triggered the workflow run. |
| [is_tag](#is_tag) | `string` | true | Indicates whether or not `triggering_ref` is a tag. |
| [is_semver](#is_semver) | `string` | true | Indicates whether or not `tag` is using semantic versioning. Always false when `is_tag` is false. |
| [tag](#tag) | `string` | v1.0.0, 1.0.0 | The tag that triggered the workflow run. Will be empty when `is_tag` is false. |
| [current_branch_name](#current_branch_name) | `string` | main, feature/example | The current working branch regardless of event type. Usually same as `base_branch_name`, but for pull requests, it's same as `head_branch_name`. |
| [is_default_branch](#is_default_branch) | `string` | true | Indicates whether or not `current_branch_name` is the default branch. |
| [default_branch_name](#default_branch_name) | `string` | main | The default branch for the repository. |
| [base_branch_name](#base_branch_name) | `string` | main, develop | The target branch of a commit, pull request, tag, or other event. |
| [head_branch_name](#head_branch_name) | `string` | feature/example | The source branch of a pull request, otherwise, it will be empty. |
| [is_pull_request](#is_pull_request) | `string` | true | Indicates whether or not `triggering_ref` is a pull request. |
| [pull_request_id](#pull_request_id) | `string` | 123 | Id of the pull request. Will be empty when `is_pull_request` is false. |
| [repo_owner_name](#repo_owner_name) | `string` | stevenjdh | The username of the user who owns the repository. |
| [repo_name](#repo_name) | `string` | my-repo | The repository name. |
| [event_actor_name](#event_actor_name) | `string` | stevenjdh | The username of the user or app that initiated the workflow run or rerun. |
| [is_event_actor_rerun](#is_event_actor_rerun) | `string` | false | Indicates whether or not `event_actor` triggered the workflow rerun. May not always be the same actor for reruns, but uses original actor's privileges for it. Will always be false for first runs. |
| [is_event_actor_owner](#is_event_actor_owner) | `string` | true | Indicates whether or not `event_actor` is the `repo_owner`. |
## Usage
Implementing this action is relatively simple with just a few steps. More practical examples can be found in the [Examples](Examples) folder.
```yaml
name: 'build'
on:
push:
branches:
- main
pull_request:
branches:
- main
types: [opened, synchronize, reopened]
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Set Branch Outputs
id: branch-details
uses: stevenjdh/branch-details@v1
with:
drop-tag-prefix: 'v'
- name: Display Action Outputs
run: |
echo "Action Outputs:"
echo "- [triggering_ref]: ${{ steps.branch-details.outputs.triggering_ref }}"
echo "- [is_tag]: ${{ steps.branch-details.outputs.is_tag }}"
echo "- [is_semver]: ${{ steps.branch-details.outputs.is_semver }}"
echo "- [tag]: ${{ steps.branch-details.outputs.tag }}"
echo "- [current_branch_name]: ${{ steps.branch-details.outputs.current_branch_name }}"
echo "- [is_default_branch]: ${{ steps.branch-details.outputs.is_default_branch }}"
echo "- [default_branch_name]: ${{ steps.branch-details.outputs.default_branch_name }}"
echo "- [base_branch_name]: ${{ steps.branch-details.outputs.base_branch_name }}"
echo "- [head_branch_name]: ${{ steps.branch-details.outputs.head_branch_name }}"
echo "- [is_pull_request]: ${{ steps.branch-details.outputs.is_pull_request }}"
echo "- [pull_request_id]: ${{ steps.branch-details.outputs.pull_request_id }}"
echo "- [repo_owner_name]: ${{ steps.branch-details.outputs.repo_owner_name }}"
echo "- [repo_name]: ${{ steps.branch-details.outputs.repo_name }}"
echo "- [event_actor_name]: ${{ steps.branch-details.outputs.event_actor_name }}"
echo "- [is_event_actor_rerun]: ${{ steps.branch-details.outputs.is_event_actor_rerun }}"
echo "- [is_event_actor_owner]: ${{ steps.branch-details.outputs.is_event_actor_owner }}"
```
## Disclaimer
Branch Details is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
## Contributing
Thanks for your interest in contributing! There are many ways to contribute to this project. Get started [here](https://github.com/StevenJDH/.github/blob/main/docs/CONTRIBUTING.md).
## Do you have any questions?
Many commonly asked questions are answered in the FAQ:
[https://github.com/StevenJDH/branch-details/wiki/FAQ](https://github.com/StevenJDH/branch-details/wiki/FAQ)
## Want to show your support?
|Method | Address |
|---------------:|:------------------------------------------------------------------------------------------|
|PayPal: | [https://www.paypal.me/stevenjdh](https://www.paypal.me/stevenjdh "Steven's Paypal Page") |
|Cryptocurrency: | [Supported options](https://github.com/StevenJDH/StevenJDH/wiki/Donate-Cryptocurrency) |
// Steven Jenkins De Haro ("StevenJDH" on GitHub)