Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
DuniterPy
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
clients
python
DuniterPy
Commits
6b011de3
Commit
6b011de3
authored
3 years ago
by
Moul
Browse files
Options
Downloads
Patches
Plain Diff
[doc]
#149
: Add dev workflow ɧ, Update release workflow
parent
dbf30571
No related branches found
No related tags found
No related merge requests found
Pipeline
#13204
passed
3 years ago
Stage: checks
Stage: tests
Changes
1
Pipelines
2
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+14
-6
14 additions, 6 deletions
CONTRIBUTING.md
with
14 additions
and
6 deletions
CONTRIBUTING.md
+
14
−
6
View file @
6b011de3
# Contribute guide
# Contribute guide
## Development workflow
Create and push a feature or bugfix release out of the
`main`
branch.
Name this branch after the ticket number
`###`
.
Open a merge out of this branch to the
`main`
branch:
```
bash
main <-
###_feature_branch
```
## Pre-commit
## Pre-commit
We are using
[
`pre-commit`
](
https://pre-commit.com/
)
tool to perform checks on staged changes before committing.
We are using
[
`pre-commit`
](
https://pre-commit.com/
)
tool to perform checks on staged changes before committing.
We are using it for
`black`
formatting,
`isort`
imports sorting,
`pylint`
code linting,
`mypy`
typing, and
`gitlab-ci`
linting.
We are using it for
`black`
formatting,
`isort`
imports sorting,
`pylint`
code linting,
`mypy`
typing, and
`gitlab-ci`
linting.
...
@@ -56,10 +64,10 @@ Follow [this documentation](https://github.com/Lucas-C/pre-commit-hooks#removing
...
@@ -56,10 +64,10 @@ Follow [this documentation](https://github.com/Lucas-C/pre-commit-hooks#removing
Only difference is to update the year in
`license_header.txt`
rather than
`LICENSE.txt`
.
Only difference is to update the year in
`license_header.txt`
rather than
`LICENSE.txt`
.
## Release workflow
## Release workflow
To handle a release, you have to
respect
this workflow:
To handle a release, you have to
follow
this workflow:
*
Verify all features and bug fixes are merged in the
`
dev
`
branch.
*
Verify all features and bug fixes are merged in the
`
main
`
branch.
*
Checkout on the
`
dev
`
branch
*
Checkout on the
`
main
`
branch
*
Update the
`CHANGELOG.md`
file and commit
*
Update the
`CHANGELOG.md`
file and commit
*
Run the
`release.sh`
script with the version semantic number as argument:
*
Run the
`release.sh`
script with the version semantic number as argument:
...
@@ -67,6 +75,6 @@ To handle a release, you have to respect this workflow:
...
@@ -67,6 +75,6 @@ To handle a release, you have to respect this workflow:
./release.sh 0.50.0
./release.sh 0.50.0
```
```
*
A new commit is added with the version number and a tag in git.
*
Create a MR containing the changelog and the commit updating the version
*
Merge all new commits from
`dev`
to
`master`
on GitLab with a merge request.
*
Once the MR is merged to
`main`
, push the tag with
`git push --tags`
*
R
elease o
n
PyPI
from the GitLab pipelin
e manual job o
f
the
`ma
ster
`
branch
.
*
To r
elease
t
o PyPI
, the pipeline based on the tag should be used by triggerring th
e manual job o
n
the
`ma
in
`
branch
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