Skip to content

Commit

Permalink
Merge pull request #227 from MannLabs/adapt-to-new-release-workflow
Browse files Browse the repository at this point in the history
Remove installer building from release workflow
  • Loading branch information
mschwoer authored Nov 4, 2024
2 parents 077b6db + d78728e commit b7a8e68
Show file tree
Hide file tree
Showing 24 changed files with 11 additions and 588 deletions.
13 changes: 0 additions & 13 deletions .bumpversion.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,5 @@ serialize =

[bumpversion:file:./docs/conf.py]

[bumpversion:file:./release/one_click_linux_gui/control]

[bumpversion:file:./release/one_click_linux_gui/create_installer_linux.sh]

[bumpversion:file:./release/one_click_macos_gui/distribution.xml]

[bumpversion:file:./release/one_click_macos_gui/Info.plist]

[bumpversion:file:./release/one_click_macos_gui/create_installer_macos.sh]

[bumpversion:file:./release/one_click_windows_gui/create_installer_windows.sh]

[bumpversion:file:./release/one_click_windows_gui/alphabase_innoinstaller.iss]
search = {current_version}
replace = {new_version}
80 changes: 0 additions & 80 deletions .github/workflows/publish_and_release.yaml

This file was deleted.

11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,17 @@ For an even more interactive participation, check out the
[the Contributors License Agreement](misc/CLA.md).

### Notes for developers

#### Tagging of changes
In order to have release notes automatically generated, changes need to be tagged with labels.
The following labels are used (should be safe-explanatory):
`breaking-change`, `bug`, `enhancement`.

#### Release a new version
This package uses a shared release process defined in the
[alphashared](https://github.com/MannLabs/alphashared) repository. Please see the instructions
[there](https://github.com/MannLabs/alphashared/blob/reusable-release-workflow/.github/workflows/README.md#release-a-new-version).

#### pre-commit hooks
It is highly recommended to use the provided pre-commit hooks, as the CI pipeline enforces all checks therein to
pass in order to merge a branch.
Expand Down
58 changes: 0 additions & 58 deletions misc/checklist.txt
Original file line number Diff line number Diff line change
@@ -1,16 +1,8 @@
######## ALWAYS TODO ########

Versions updated
conda activate alphabase
cd misc
bumpversion patch --config-file bumpversion.cfg
conda deactivate
# bumpversion patch --new-version VERSION --config-file bumpversion.cfg

No TODOs left?

README updated?
- Update CHANGELOG

Manuals updated?
if [ misc/gui_manual.docx -nt alphabase/docs/gui_manual.pdf ]; then
Expand All @@ -19,53 +11,3 @@ Manuals updated?
if [ misc/cli_manual.docx -nt alphabase/docs/cli_manual.pdf ]; then
echo "CLI manual was not updated"
fi

Tutorial and performance?
conda activate alphabase
jupyter nbconvert --execute --inplace --to notebook --NotebookClient.kernel_name="python" nbs/tutorial.ipynb nbs/performance.ipynb
jupyter nbconvert --to html --NotebookClient.kernel_name="python" nbs/tutorial.ipynb nbs/performance.ipynb
conda deactivate






######## AUTOMATED BY NOW ########

Merged into master branch?

Tests passing?
python -m unittest tests.test_bruker

ReadTheDocs up-to-date?
Docs updated?
cd docs
make html
# https://docs.readthedocs.io/en/stable/
https://alphabase.readthedocs.io/en/latest/

Releases for all Windows, MacOS and Linux?

cd misc/one_click_macos
source create_installer_macos.sh

cd misc/one_click_linux
source create_installer_linux.sh

cd misc/one_click_windows
create_installer_windows.bat

PyPi up-to-date?
# https://realpython.com/pypi-publish-python-package/
conda activate alphabase_pip
rm -rf dist
rm -rf build
python setup.py sdist bdist_wheel
twine check dist/*
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
conda create -n alphabase_pip_test python=3.9 -y
conda activate alphabase_pip_test
# WARNING!!!!! Test on all OS
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple "alphabase"
twine upload dist/*
Binary file removed release/logos/alpha_logo.icns
Binary file not shown.
Binary file removed release/logos/alpha_logo.ico
Binary file not shown.
Binary file removed release/logos/alpha_logo.png
Binary file not shown.
7 changes: 0 additions & 7 deletions release/one_click_linux_gui/control

This file was deleted.

36 changes: 0 additions & 36 deletions release/one_click_linux_gui/create_installer_linux.sh

This file was deleted.

24 changes: 0 additions & 24 deletions release/one_click_macos_gui/Info.plist

This file was deleted.

13 changes: 0 additions & 13 deletions release/one_click_macos_gui/Resources/conclusion.html

This file was deleted.

13 changes: 0 additions & 13 deletions release/one_click_macos_gui/Resources/welcome.html

This file was deleted.

3 changes: 0 additions & 3 deletions release/one_click_macos_gui/alphabase_terminal

This file was deleted.

44 changes: 0 additions & 44 deletions release/one_click_macos_gui/create_installer_macos.sh

This file was deleted.

17 changes: 0 additions & 17 deletions release/one_click_macos_gui/distribution.xml

This file was deleted.

6 changes: 0 additions & 6 deletions release/one_click_macos_gui/scripts/postinstall

This file was deleted.

5 changes: 0 additions & 5 deletions release/one_click_macos_gui/scripts/preinstall

This file was deleted.

Loading

0 comments on commit b7a8e68

Please sign in to comment.