Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
adaptive
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
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
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
Quantum Tinkerer
adaptive
Merge requests
!93
add a release guide
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
add a release guide
release
into
master
Overview
4
Commits
2
Pipelines
43
Changes
1
Merged
Bas Nijholt
requested to merge
release
into
master
6 years ago
Overview
4
Commits
2
Pipelines
43
Changes
1
Expand
Even though there are very few steps involved, it is good to have it documented.
Edited
6 years ago
by
Bas Nijholt
0
0
Merge request reports
Viewing commit
bc214dd7
Show latest version
1 file
+
74
−
0
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
bc214dd7
add a release guide
· bc214dd7
Bas Nijholt
authored
6 years ago
RELEASE.md
0 → 100644
+
74
−
0
Options
# Making a Adaptive release
This document guides a contributor through creating a release of Adaptive.
## Preflight checks
The following checks should be made
*before*
tagging the release.
#### Check that all issues are resolved
Check that all the issues and merge requests for the appropriate
[
milestone
](
https://gitlab.kwant-project.org/qt/adaptive/issues
)
have been resolved. Any unresolved issues should have their milestone
bumped.
#### Ensure that all tests pass
For major and minor releases we will be tagging the
``master``
branch.
This should be as simple as verifying that the
[
latest CI pipeline
](
https://gitlab.kwant-project.org/qt/adaptive/pipelines
)
succeeded.
#### Verify that `AUTHORS.md` is up-to-date
The following command shows the number of commits per author since the last
annotated tag:
```
t=$(git describe --abbrev=0); echo Commits since $t; git shortlog -s $t..
```
## Make a release, but do not publish it yet
### Tag the release
Make an
**annotated, signed**
tag for the release. The tag must have the name:
```
git tag -s v<version> -m "version <version>"
```
### Build a source tarball and wheels and test it
```
rm -fr build dist
python setup.py sdist bdist_wheel
```
This creates the file
`dist/adaptive-<version>.tar.gz`
. It is a good idea to unpack it
and check that the tests run:
```
tar xzf dist/adaptive*.tar.gz
cd adaptive-*
py.test .
```
## Upload to PyPI
```
twine upload dist/*
```
## Update the [conda-forge recipe](https://github.com/conda-forge/adaptive-feedstock)
*
Fork the
[
feedstock repo
](
https://github.com/conda-forge/adaptive-feedstock
)
*
Change the version number and sha256 in
`recipe/meta.yaml`
and commit to your fork
*
Open a
[
Pull Request
](
https://github.com/conda-forge/adaptive-feedstock/compare
)
*
Type
`@conda-forge-admin, please rerender`
as a comment
*
When the tests succeed, merge
Loading