https://github.com/somaz94/commit-info-extractor
commit-info-extractor
https://github.com/somaz94/commit-info-extractor
automation changelog ci-cd devops git-commit git-log github-action github-actions release
Last synced: 6 days ago
JSON representation
commit-info-extractor
- Host: GitHub
- URL: https://github.com/somaz94/commit-info-extractor
- Owner: somaz94
- License: mit
- Created: 2024-06-03T01:37:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-26T07:22:53.000Z (14 days ago)
- Last Synced: 2026-03-27T02:12:57.492Z (13 days ago)
- Topics: automation, changelog, ci-cd, devops, git-commit, git-log, github-action, github-actions, release
- Language: Python
- Homepage: https://github.com/marketplace/actions/extract-commit-action
- Size: 208 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Extract Commit Action
[](https://github.com/somaz94/commit-info-extractor/blob/main/LICENSE)
[](https://github.com/marketplace/actions/extract-commit-action)
A powerful GitHub Action that extracts and processes information from commit messages using customizable patterns and commands.
## Features
- **Flexible Pattern Matching**: Extract information using regex patterns or custom commands
- **Multiple Output Formats**: Support for text, JSON, and CSV outputs
- **Customizable Depth**: Control the number of commits to analyze
- **Fast & Lightweight**: Built with Python 3.14-slim for optimal performance
- **Fail-Safe Options**: Optional validation with `fail_on_empty`
- **Pretty Formatting**: Clean, formatted commit message output
- **Debug Mode**: Verbose output for troubleshooting
- **Timeout Control**: Prevent long-running operations
- **Easy Integration**: Simple YAML configuration in your workflows
## Quick Start
```yaml
- name: Extract Environment from Commits
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_command: "grep -oE 'env:(\\w+)'"
pretty: true
key_variable: 'DEPLOY_ENV'
```
## Inputs
| Input | Description | Required | Default |
|-------|-------------|----------|---------|
| `commit_limit` | Number of commits to retrieve | Yes | N/A |
| `extract_command` | Command to extract info (e.g., grep pattern) | No | N/A |
| `extract_pattern` | Regex pattern to extract info (safer alternative to `extract_command`) | No | N/A |
| `commit_range` | Git commit range (e.g., `HEAD~5..HEAD`, `v1.0.0..v1.1.0`) | No | N/A |
| `pretty` | Use pretty format for Git logs | No | `false` |
| `key_variable` | Name of the output variable | No | `ENVIRONMENT` |
| `fail_on_empty` | Fail if no information is extracted | No | `false` |
| `output_format` | Output format: `text`, `json`, or `csv` | No | `text` |
| `debug` | Enable debug mode for verbose output | No | `false` |
| `timeout` | Timeout in seconds for git/extract commands | No | `30` |
> **Note**: `extract_command` and `extract_pattern` are mutually exclusive. Use `extract_pattern` for safer regex matching without shell execution.
## Outputs
| Output | Description |
|--------|-------------|
| `key_variable` | The name of the variable used |
| `value_variable` | The extracted value(s) from commits |
| `match_count` | Number of extracted matches |
## Common Use Cases
### Extract Environment Information
```yaml
- name: Extract Environment
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_command: "grep -oE 'env:(\\w+)'"
pretty: true
key_variable: 'DEPLOY_ENV'
```
### Find Feature Tags
```yaml
- name: Extract Feature Tags
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_command: "grep -oE 'feature:(\\w+)'"
key_variable: 'FEATURE_TAG'
```
### Extract Version Numbers
```yaml
- name: Extract Version
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_command: "grep -oE 'v[0-9]+\\.[0-9]+\\.[0-9]+'"
key_variable: 'VERSION'
```
### Fail on Empty Results
```yaml
- name: Extract Critical Changes
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_command: "grep -oE 'critical:(\\w+)'"
key_variable: 'CRITICAL_CHANGES'
fail_on_empty: true # Fails if no matches found
```
### Extract JIRA Tickets with JSON Output
```yaml
- name: Extract JIRA Tickets
id: jira
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 20
extract_command: "grep -oE 'JIRA-[0-9]+'"
key_variable: 'JIRA_TICKETS'
output_format: 'json'
- name: Process Tickets
run: |
echo '${{ steps.jira.outputs.value_variable }}' | jq -r '.[]'
```
### Extract Using Regex Pattern (Safe)
```yaml
- name: Extract JIRA Tickets (Pattern)
id: jira_pattern
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_pattern: 'JIRA-[0-9]+'
key_variable: 'JIRA_TICKETS'
- name: Check Match Count
run: |
echo "Found ${{ steps.jira_pattern.outputs.match_count }} tickets"
echo "Tickets: ${{ steps.jira_pattern.outputs.value_variable }}"
```
### Extract from Commit Range
```yaml
- name: Extract Changes Between Tags
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
commit_range: 'v1.0.0..v1.1.0'
extract_pattern: '(feat|fix|chore):'
key_variable: 'CHANGE_TYPES'
- name: Extract Recent Changes
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
commit_range: 'HEAD~5..HEAD'
extract_pattern: 'env:(\w+)'
key_variable: 'DEPLOY_ENV'
```
### Debug Mode for Troubleshooting
```yaml
- name: Extract with Debug
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_command: "grep -oE 'env:(\\w+)'"
key_variable: 'ENVIRONMENT'
debug: true # Enable verbose output
timeout: 60 # Set custom timeout
```
## Output Formats
The action supports three output formats:
| Format | Description | Example Output |
|--------|-------------|----------------|
| `text` | Plain text (default) | `value1`
`value2`
`value3` |
| `json` | JSON array | `["value1", "value2", "value3"]` |
| `csv` | Comma-separated | `value1,value2,value3` |
### Format Examples
Given extracted values: `JIRA-123`, `JIRA-456`, `JIRA-789`
#### Text format:
```
JIRA-123
JIRA-456
JIRA-789
```
#### JSON format:
```json
["JIRA-123", "JIRA-456", "JIRA-789"]
```
#### CSV format:
```
JIRA-123,JIRA-456,JIRA-789
```
## Extract Command Examples
| Purpose | Command | Example Match |
|---------|---------|---------------|
| Environment | `grep -oE 'env:(\\w+)'` | `env:production` |
| Fix IDs | `grep -oE 'fix-[0-9]+'` | `fix-123` |
| Versions | `grep -oE 'v[0-9]+\\.[0-9]+\\.[0-9]+'` | `v1.2.3` |
| Features | `grep -oE 'feature:(\\w+)'` | `feature:login` |
| JIRA IDs | `grep -oE 'JIRA-[0-9]+'` | `JIRA-456` |
| Conventional Commits | `grep -oE '^(feat|fix|chore|docs):'` | `feat:`, `fix:` |
> **Note**: Use `grep -oE` (Extended regex) instead of `grep -oP` (Perl regex) for better compatibility.
## Extract Pattern Examples
`extract_pattern` uses Python's `re` module for safe regex matching without shell execution.
| Purpose | Pattern | Example Match |
|---------|---------|---------------|
| Environment | `env:(\w+)` | `production` (captured group) |
| JIRA IDs | `JIRA-[0-9]+` | `JIRA-456` |
| Versions | `v\d+\.\d+\.\d+` | `v1.2.3` |
| Conventional Commits | `(feat\|fix\|chore\|docs):` | `feat:`, `fix:` |
| PR Numbers | `#(\d+)` | `123` (captured group) |
> **Note**: When using capture groups `()`, only the captured portion is returned. Without groups, the full match is returned.
## Best Practices
### Commit Message Format
- Use consistent commit message formats (e.g., [Conventional Commits](https://www.conventionalcommits.org/))
- Include relevant tags or identifiers
- Example: `feat(auth): add login functionality env:production`
### Extraction Patterns
- Test regex patterns locally before implementation:
```bash
echo "feat: add login env:production" | grep -oE 'env:(\\w+)'
```
- Use specific patterns to avoid false matches
- Consider edge cases and special characters
### Performance
- Set appropriate `commit_limit` based on your needs
- Lower values = faster execution
- Typical range: 10-50 commits
### Repository Setup
- Ensure sufficient `fetch-depth` in checkout action:
```yaml
- uses: actions/checkout@v6
with:
fetch-depth: 20 # Match or exceed commit_limit
```
## Troubleshooting
### No Matches Found
#### Problem: Action completes but returns empty results
#### Solutions:
1. Verify commit messages contain expected patterns:
```bash
git log -10 --pretty=%B
```
2. Test your regex pattern locally:
```bash
git log -10 --pretty=%B | grep -oE 'your-pattern'
```
3. Ensure `fetch-depth` in checkout is sufficient
4. Check if `fail_on_empty` is set appropriately
### Incorrect Matches
#### Problem: Extracting wrong or unexpected values
#### Solutions:
- Review and refine your regex pattern
- Use more specific patterns with word boundaries
- Test with sample commit messages first
- Use online regex testers like [regex101.com](https://regex101.com)
### Action Fails with Error
#### Problem: Action exits with non-zero code
#### Possible Causes:
- `fail_on_empty: true` is set and no matches found (intended behavior)
- Invalid regex pattern in `extract_command`
- Git repository not available
- Insufficient permissions
#### Debug Steps:
```yaml
- name: Debug Commit Messages
run: git log -${{ inputs.commit_limit }} --pretty=%B
- name: Test Extract Command
run: |
git log -10 --pretty=%B | grep -oE 'your-pattern' || echo "No matches"
# Or use built-in debug mode
- name: Extract with Debug Mode
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_command: "grep -oE 'your-pattern'"
debug: true # Shows detailed execution information
```
### Timeout Errors
#### Problem: Action times out during execution
#### Solutions:
- Increase timeout value (default is 30 seconds):
```yaml
- uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_command: "complex-command"
timeout: 120 # Increase to 2 minutes
```
- Reduce `commit_limit` to process fewer commits
- Simplify your `extract_command` pattern
## Advanced Usage
### Processing Multiple Matches
When multiple values are extracted, you can process them in subsequent steps:
#### Text format:
```yaml
- name: Extract JIRA Tickets
id: extract
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_command: "grep -oE 'JIRA-[0-9]+'"
key_variable: 'JIRA_TICKETS'
- name: Process Each Ticket
run: |
while IFS= read -r ticket; do
echo "Processing: $ticket"
# Your processing logic here
done <<< "${{ steps.extract.outputs.value_variable }}"
```
#### JSON format:
```yaml
- name: Extract as JSON
id: extract_json
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 10
extract_command: "grep -oE 'JIRA-[0-9]+'"
output_format: 'json'
- name: Process JSON Array
run: |
echo '${{ steps.extract_json.outputs.value_variable }}' | \
jq -r '.[]' | while read -r ticket; do
echo "Processing: $ticket"
done
```
### Combining with Other Actions
#### Send to Slack:
```yaml
- name: Extract Deployment Info
id: deploy
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 5
extract_command: "grep -oE 'env:(\\w+)'"
key_variable: 'ENVIRONMENT'
- name: Notify Slack
uses: slackapi/slack-github-action@v1
with:
payload: |
{
"text": "Deploying to: ${{ steps.deploy.outputs.value_variable }}"
}
```
#### Conditional Deployment:
```yaml
- name: Check for Production Tag
id: check_env
uses: somaz94/commit-info-extractor@v1
with:
commit_limit: 1
extract_command: "grep -oE 'env:production'"
fail_on_empty: false
- name: Deploy to Production
if: steps.check_env.outputs.value_variable == 'env:production'
run: |
echo "Deploying to production..."
```
## Security Considerations
When using this action, keep the following in mind:
#### Command Injection Prevention
- The `extract_command` executes shell commands — never use untrusted user input
- Prefer `extract_pattern` over `extract_command` for safer regex matching (no shell execution)
- Always validate and sanitize inputs
#### Sensitive Information
- Be careful not to extract secrets or credentials from commit messages
- Use GitHub's [secret scanning](https://docs.github.com/en/code-security/secret-scanning) alongside this action
- Consider filtering sensitive patterns
#### Permission Scopes
- This action only requires **read access** to repository content
- Follow the principle of least privilege in your workflows
## Project Structure
```
entrypoint.py # Thin wrapper (calls app.main.run)
app/
main.py # Orchestration entrypoint
config.py # AppConfig dataclass (from_env, validate)
git_client.py # Git operations (configure, fetch commits)
extractor.py # Extraction logic (command & regex pattern)
formatter.py # Output formatting (text/json/csv)
output_writer.py # GITHUB_ENV/GITHUB_OUTPUT writing
logger.py # Logging utilities
tests/
conftest.py # pytest fixtures
test_config.py # Config unit tests
test_extractor.py # Extraction logic tests
test_formatter.py # Formatter tests
test_git_client.py # Git client tests
test_output_writer.py # Output writer tests
test_main.py # Integration tests (mocked)
test_local.py # Local integration test
```
## Local Testing
```bash
# Clone the repository
git clone https://github.com/somaz94/commit-info-extractor.git
cd commit-info-extractor
# Using Makefile (recommended)
make venv # Create virtualenv and install dev dependencies
make test # Run unit tests with coverage
make test-local # Run local integration test
make coverage # Generate HTML coverage report
make clean # Remove venv, cache, and build artifacts
make help # Show all available commands
# Or manually
python -m venv venv && source venv/bin/activate
pip install -r requirements-dev.txt
python -m pytest tests/ -v --cov=app --cov-report=term-missing
```
See [tests/TESTING.md](tests/TESTING.md) for more details.
## Changelog
See [CHANGELOG.md](CHANGELOG.md) for version history and updates.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! Please feel free to:
- Report bugs
- Suggest new features
- Submit pull requests
- Improve documentation
## Support
If you find this action helpful, please consider:
- Starring the repository
- Sharing with others
- Contributing improvements
## Related Projects
- [actions/checkout](https://github.com/actions/checkout) - Checkout your repository
- [github-script](https://github.com/actions/github-script) - Write workflows using JavaScript
- [setup-python](https://github.com/actions/setup-python) - Set up Python environment
---
Made by [somaz94](https://github.com/somaz94)