Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
concepts-processing
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Package registry
Operate
Terraform modules
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
meldb
concepts-processing
Commits
b749fbad
Commit
b749fbad
authored
4 months ago
by
mjbonifa
Browse files
Options
Downloads
Patches
Plain Diff
docs (documentation): git workflow documentation
parent
ac87eca9
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/index.md
+61
-1
61 additions, 1 deletion
docs/index.md
with
61 additions
and
1 deletion
docs/index.md
+
61
−
1
View file @
b749fbad
...
@@ -172,3 +172,63 @@ The `phen` command is used phenotype-related operations.
...
@@ -172,3 +172,63 @@ The `phen` command is used phenotype-related operations.
-
`-d`
,
`--phen-dir`
: (Optional) Directory of current phenotype configuration (the default is ./build/phen).
-
`-d`
,
`--phen-dir`
: (Optional) Directory of current phenotype configuration (the default is ./build/phen).
-
`-old`
,
`--phen-dir-old`
: (Required) Directory of old phenotype version)
-
`-old`
,
`--phen-dir-old`
: (Required) Directory of old phenotype version)
# GitLab Workflow for Managing Releases
## Branching Strategy
### 1. Main Branch (`main`)
-
Represents the stable production-ready code.
-
Contains only release versions.
-
Direct commits are not allowed; changes must go through a pull request (PR) from
`dev`
.
-
Merges into
`main`
require authorization from a repository maintainer or admin.
-
Protected branch settings should enforce code reviews and approvals before merging.
### 2. Development Branch (`dev`)
-
Used for integration and testing.
-
All feature branches must be merged here first before reaching
`main`
.
-
Regularly synced with
`main`
to keep it up to date.
### 3. Feature Branches (`feature-xxx`)
-
Created for each issue or feature.
-
Always branch from
`dev`
based on an issue.
-
Named according to the issue number and short description (e.g.,
`feature-123-user-auth`
).
-
Can be created directly from the issue page in GitLab by selecting "Create Branch".
-
Merged into
`dev`
through a pull request.
## Pull Request Sequence
1.
**Create a Feature Branch**
-
Branch from
`dev`
:
`git checkout -b feature-xxx dev`
-
Alternatively, create the branch from the issue itself in GitLab.
-
Implement feature and commit changes following commit message guidelines.
2.
**Push the Branch**
-
`git push origin feature-xxx`
3.
**Create a Merge Request (MR) to `dev`**
-
Ensure code review and approvals before merging.
-
Resolve conflicts if any.
4.
**Merge to `dev`**
-
Squash and merge when approved.
-
Delete feature branch after successful merge.
5.
**Release to `main`**
-
Create a merge request from
`dev`
to
`main`
.
-
Perform final testing.
-
Tag the release with versioning (e.g.,
`v1.0.0`
).
-
Deploy to production after approval.
-
Requires authorization from a repository maintainer or admin before merging.
## Commit Message Guidelines
-
Use clear and descriptive commit messages.
-
Format:
`<type>(<scope>): <description>`
-
Example:
`docs (documentation): git workflow documentation`
-
Types:
`feat`
(feature),
`fix`
(bug fix),
`docs`
(documentation),
`refactor`
(code refactoring),
`test`
(tests),
`chore`
(maintenance).
## Additional Guidelines
-
Always pull the latest changes before starting a new feature:
`git pull origin dev`
-
Write unit tests for new features.
-
Keep feature branches short-lived and regularly updated with
`dev`
.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment