Skip to content

Commit

Permalink
fix(*): update branch content with develop's changes
Browse files Browse the repository at this point in the history
  • Loading branch information
JeferssonCL committed Sep 12, 2024
2 parents 8cd6cbb + 8f9805b commit c2d40bc
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 10 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/check_branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ jobs:
steps:
- uses: deepakputhraya/action-branch-name@master
with:
regex: '([a-z])+\/([a-z_-])+\/([a-z_-])+'
regex: '([a-z])+\/([\dA-Za-z_-])+\/([\dA-Za-z_-])+\/([\dA-Za-z_-])+'
allowed_prefixes: 'feature,stable,fix,chore,docs,feat,build,ci,test,refactor,perf'
ignore: main,stage,develop
min_length: 4
max_length: 120
max_length: 150
11 changes: 6 additions & 5 deletions documentation/branch-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ Our branch naming strategy follows a specific format and uses prefixes to
indicate the purpose of the branch. The naming convention is structured as
follows:

- **Format**: `prefix/name/description`
- **prefix**: Indicates the type of work being done.
- **name**: Provides the last name of the developer in charge of the ticket.
- **description**: A brief description of the branch's purpose.
- Format: `prefix/taskId/username/taskName`
- `prefix`: Indicates the type of work (e.g., feature, fix, chore).
- `taskId`: The task ID or ticket number associated with the branch.
- `username`: The developer's username or last name.
- `taskName`: The task or feature name.

### Allowed Prefixes

Expand Down Expand Up @@ -54,7 +55,7 @@ to follow the naming rules:
Branch names must adhere to the following length constraints:

- **Minimum Length**: 4 characters
- **Maximum Length**: 120 characters
- **Maximum Length**: 150 characters

By following this branch naming strategy, we ensure clarity and consistency in
our workflow, making it easier to understand the purpose and context of each
Expand Down
7 changes: 4 additions & 3 deletions documentation/git-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@ overview of our Git Flow:

## Branch Strategy

- Format: `prefix/name/description`
- Format: `prefix/taskId/username/taskName`
- `prefix`: Indicates the type of work (e.g., feature, fix, chore).
- `name`: The last name of the developer in charge of the ticket.
- `description`: Brief description of the branch's purpose.
- `taskId`: The task ID or ticket number associated with the branch.
- `username`: The developer's username or last name.
- `taskName`: The task or feature name.
- Allowed prefixes include: feature, stable, fix, chore, docs, feat, build, ci,
test, refactor, perf.

Expand Down
Binary file modified documentation/git-workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c2d40bc

Please sign in to comment.