https://github.com/nicklegan/repository-naming-convention-action
A GitHub Action that generates a report with all repository names including the date of creation belonging to an organization not matching a set regex string.
https://github.com/nicklegan/repository-naming-convention-action
github-actions naming-conventions
Last synced: 2 months ago
JSON representation
A GitHub Action that generates a report with all repository names including the date of creation belonging to an organization not matching a set regex string.
- Host: GitHub
- URL: https://github.com/nicklegan/repository-naming-convention-action
- Owner: nicklegan
- License: mit
- Created: 2021-06-04T09:11:18.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-16T16:25:06.000Z (almost 4 years ago)
- Last Synced: 2024-10-05T11:41:39.225Z (8 months ago)
- Topics: github-actions, naming-conventions
- Language: JavaScript
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: license
- Code of conduct: .github/code_of_conduct.md
Awesome Lists containing this project
README
# GitHub Repository Naming Convention Action
> A GitHub Action that generates a report with all repository names including the date of creation belonging to an organization not matching a set regex string.
## Workflow
The example [workflow](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions) below runs on a weekly [schedule](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events) and can be executed manually using a [workflow_dispatch](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#manual-events) event.
```yml
on:
workflow_dispatch:
schedule:
- cron: '0 0 * * 0' # Once per week at midnight on Sunday
name: Incorrect Naming Convention Report
jobs:
report:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Create Incorrect Naming Convention Report
uses: nicklegan/repository-naming-convention-action@main
with:
token: ${{ secrets.REPO_TOKEN }}
regex: '^([a-z0-9]+)-([a-z0-9]+)$'
flags: i
```
## GitHub secrets
| Name | Value | Required |
| :------------ | :---------------------------------------| :------- |
| `REPO_TOKEN` | A `repo` scoped [Personal Access Token] | `true` |
| `ACTIONS_STEP_DEBUG` | `true` [Enables diagnostic logging] | `false` |
## Action inputs
| Name | Description | Default | Required |
| :--------------- | :---------------------------------------------------------- | :----------------------------------------------- | :------- |
| `regex` | A regex string matching correct repo naming conventions | `^([a-z0-9]+)-([a-z0-9]+)$` | `true` |
| `flags` | Flag for repo naming regex string. e.g. 'i' for case-insensitive | `i` | `false` |
| `report-path` | Path within the repository to create the report CSV file | `reports/incorrect-naming-convention-report.csv` | `false` |
| `committer-name` | The name of the committer to be displayed in the history | `github-actions` | `false` |
| `committer-email`| The email of the committer to be displayed in the history | `[email protected]` | `false` |
## Regex examples
Regex example 1: `####-####` (2 fixed groups separated by a dash).
- `^([a-z0-9]+)-([a-z0-9]+)$`
Regex example 2: `prefix-####-####-*` (3 groups separated by dashes starting with a prefix).
- `^(prefix)-([a-z0-9]+)-([a-z0-9]+)`
Regex example 3: `####-####-####-*` (3 groups containing names and numbers divided by dashes).
- `^([a-z0-9]+)-([a-z0-9]+)-([a-z0-9]+)`
As a default the `i` flag is recommended to allow matches to be case-insensitive
:bulb: For more info about regular expressions visit [Regular-Expressions.info](https://www.regular-expressions.info)
[Personal Access Token]: https://github.com/settings/tokens/new?scopes=repo&description=GitHub+Repository+Naming+Convention+Action 'Personal Access Token'
[Enables diagnostic logging]: https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging#enabling-runner-diagnostic-logging 'Enabling runner diagnostic logging'