Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-advanced-user-tools
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue 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
caosdb
Software
caosdb-advanced-user-tools
Commits
3f4a110b
Verified
Commit
3f4a110b
authored
3 years ago
by
Daniel Hornung
Browse files
Options
Downloads
Patches
Plain Diff
DOC: Release guidelines.
parent
cf49668e
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!39
Release 0.4.0
Pipeline
#18741
failed
3 years ago
Stage: setup
Stage: cert
Stage: style
Stage: unittest
Stage: integrationtest
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
RELEASE_GUIDELINES.md
+43
-0
43 additions, 0 deletions
RELEASE_GUIDELINES.md
with
43 additions
and
0 deletions
RELEASE_GUIDELINES.md
0 → 100644
+
43
−
0
View file @
3f4a110b
# Release Guidelines for the CaosDB Python Client Library
This document specifies release guidelines in addition to the general release
guidelines of the CaosDB Project
(
[
RELEASE_GUIDELINES.md
](
https://gitlab.com/caosdb/caosdb/blob/dev/RELEASE_GUIDELINES.md
)
)
## General Prerequisites
*
All tests are passing.
*
FEATURES.md is up-to-date and a public API is being declared in that document.
*
CHANGELOG.md is up-to-date.
*
DEPENDENCIES.md is up-to-date.
## Steps
1.
Create a release branch from the dev branch. This prevents further changes
to the code base and a never ending release process. Naming:
`release-<VERSION>`
2.
Update CHANGELOG.md
3.
Check all general prerequisites.
4.
Update the version:
-
`version`
variables in
`docs/conf.py`
-
Version on
[
setup.py
](
./setup.py
)
: Check the
`MAJOR`
,
`MINOR`
,
`MICRO`
,
`PRE`
variables and set
`ISRELEASED`
to
`True`
. Use the possibility to issue pre-release versions for testing.
5.
Merge the release branch into the main branch.
6.
Tag the latest commit of the main branch with
`v<VERSION>`
.
7.
Delete the release branch.
8.
Remove possibly existing
`./dist`
directory with old release.
9.
Publish the release by executing
`./release.sh`
with uploads the caosdb
module to the Python Package Index
[
pypi.org
](
https://pypi.org
)
.
10.
Merge the main branch back into the dev branch.
11.
After the merge of main to dev, start a new development version by
setting
`ISRELEASED`
to
`False`
and by increasing at least the
`MICRO`
version in
[
setup.py
](
./setup.py
)
and preparing CHANGELOG.md.
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