Skip to content
Snippets Groups Projects
Commit 733f1f04 authored by Wuttke, Joachim's avatar Wuttke, Joachim
Browse files

webdoc start developer reference

parent ecacb1f7
No related branches found
No related tags found
1 merge request!1868webdoc: start developer reference
+++
title = "Developers' corner"
weight = 100
+++
## Deverlopers' corner
{{% children %}}
+++
title = "Developer build"
title = "Build"
weight = 30
+++
......
+++
title = "Release"
weight = 90
+++
## Release procedure
#### Test phase
- Declare feature freeze
- Release new versions of library dependencies (heinz, ff) if they have changed.
- Start release branch
- Update CHANGELOG
- Build packages, and test them
- installation procedures according to webdocs
- run Python scripts
- run GUI session
- import sample from script to GUI
- Start new branch in ba-www, and write release letter (`content/news/release-*.md`)
Finalize bornagain (MRs against release branch):
- Finalize CHANGELOG
- CMakeLists.txt
- In hugo/config.toml, update `baseURL`, `release_number` and `version_name`
- Set git tag v`x.y` - reversible freeze
Finalize ba-www (in fresh release branch):
- Update content/documentation.md
- Update static/js/version_switch
- In config.toml, update `version_mm`
- Add release letter
Upload installers and wheels (this makes the release irreversible):
- Build installers and wheels for all Python versions
- Installers to www@scgbuild:www/ext/ba/files/`version`.`patch`/
- Wheels to PyPI
Publish:
- Create release in Jugit
- In www@scg3:ba: for hotfix, update versioned repository (in subdirectory repo, checkout release branch and run make, make figures etc, hugo); for major release, create new versioned repository
- In www@scg3:www/ba/public, update `latest` and version link
- Merge release branch to ba-www => Docs will automatically be updated
Inform users
- Mail to BornAgain mailing list
- For major milestones, mail to external mailing lists (neutron, sa_scat [unsigned mails only!])
- Update "Latest" section on computing.mlz-garching.de
Create next release branch
- Create branch `rx.y`, push to Jugit
- In Jugit > Settings > Repository > Protected Branches, protect the branch
+++
title = "Contribute to this documentation"
weight = 99
title = "Webdoc"
weight = 70
+++
## How to contribute to this documentation
......
......@@ -5,6 +5,6 @@ weight = 20
## Building BornAgain from Source
{{% children %}}
Developers see [here](/dev/build) for additional instructions.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment