almet/dangerzone
1
0
Fork 0
mirror of https://github.com/freedomofpress/dangerzone.git synced 2025-04-28 18:02:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Update docs

Browse source
This commit is contained in:
Micah Lee 2021-06-17 10:31:14 -07:00
parent d125a5004b
commit 2d8649179a
3 changed files with 14 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
BUILD.md
View file

@ -134,16 +134,14 @@ cd "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\
vcvars32.bat vcvars32.bat
``` ```
Change to a folder where you keep source code, and clone the PyInstaller git repo and checkout the `v3.6` tag: Change to a folder where you keep source code, and clone the PyInstaller git repo and checkout the `v4.3` tag:
``` ```
git clone https://github.com/pyinstaller/pyinstaller.git git clone https://github.com/pyinstaller/pyinstaller.git
cd pyinstaller cd pyinstaller
git tag -v v4.0 git checkout v4.3
``` ```
(Note that ideally you would verify the git tag, but the PGP key that has signed the v3.5 git tag for is not published anywhere, so this isn't possible. See [this issue](https://github.com/pyinstaller/pyinstaller/issues/4430).)
The next step is to compile the bootloader. We should do this all in dangerzone's poetry shell: The next step is to compile the bootloader. We should do this all in dangerzone's poetry shell:
``` ```
@ -219,14 +217,4 @@ Then back in the first command prompt, run:
poetry run install\windows\step3-build-installer.bat poetry run install\windows\step3-build-installer.bat
``` ```
When you're done you will have `dist\Dangerzone.msi`. When you're done you will have `dist\Dangerzone.msi`.
# Release instructions
Before each release:
- Update `CHANGELOG.md`
- Update the version in `pyproject.toml`
- Update the version in `dangerzone/__init__.py`

4
README.md
View file

@ -10,8 +10,8 @@ _Read more about Dangerzone in the blog post [Dangerzone: Working With Suspiciou
## Getting started ## Getting started
- Download [Dangerzone 0.2 for Mac](https://github.com/firstlookmedia/dangerzone/releases/download/v0.2/Dangerzone.0.2.dmg) - Download [Dangerzone 0.2 for Mac](https://github.com/firstlookmedia/dangerzone/releases/download/v0.2/Dangerzone-0.2.dmg)
- Download [Dangerzone 0.2 for Windows](https://github.com/firstlookmedia/dangerzone/releases/download/v0.2/Dangerzone.0.2.msi) - Download [Dangerzone 0.2 for Windows](https://github.com/firstlookmedia/dangerzone/releases/download/v0.2/Dangerzone-0.2.msi)
- See [installing Dangerzone](https://github.com/firstlookmedia/dangerzone/wiki/Installing-Dangerzone) on the wiki for Linux repositories - See [installing Dangerzone](https://github.com/firstlookmedia/dangerzone/wiki/Installing-Dangerzone) on the wiki for Linux repositories
You can also install Dangerzone for Mac using [Homebrew](https://brew.sh/): `brew install --cask dangerzone` You can also install Dangerzone for Mac using [Homebrew](https://brew.sh/): `brew install --cask dangerzone`

18
RELEASE.md
View file

@ -6,12 +6,14 @@ This section documents the release process. Unless you're a dangerzone developer
Before making a release, all of these should be complete: Before making a release, all of these should be complete:
* Update `version` in `pyproject.toml` - [ ] Update `version` in `pyproject.toml`
* Update in `share/version.txt` - [ ] Update `share/version.txt`
* Update version and download links in `README.md` - [ ] Update version and download links in `README.md`
* CHANGELOG.md should be updated to include a list of all major changes since the last release - [ ] CHANGELOG.md should be updated to include a list of all major changes since the last release
* Test CircleCI builds: Look in `.circleci/config.yml`, manually try each build in docker, and add new platforms and remove obsolete platforms - [ ] Test CircleCI Linux builds: Look in `.circleci/config.yml`, manually try each build in docker, and add new platforms and remove obsolete platforms
* There must be a PGP-signed git tag for the version, e.g. for dangerzone 0.1.0, the tag must be `v0.1.0` - [ ] Create a test build in Windows and make sure it works
- [ ] Create a test build in mcaOS and make sure it works
- [ ] There must be a PGP-signed git tag for the version, e.g. for dangerzone 0.1.0, the tag must be `v0.1.0`
Before making a release, verify the release git tag: Before making a release, verify the release git tag:
@ -48,7 +50,7 @@ This process ends up with the final file:
dist/Dangerzone.dmg dist/Dangerzone.dmg
``` ```
Rename `Dangerzone.dmg` to `Dangerzone $VERSION.dmg`. Rename `Dangerzone.dmg` to `Dangerzone-$VERSION.dmg`.
## Windows release ## Windows release
@ -63,7 +65,7 @@ To make a Windows release, go to the Windows build machine:
- Back in the first command prompt, run: `poetry run install\windows\step3-build-installer.bat` - Back in the first command prompt, run: `poetry run install\windows\step3-build-installer.bat`
- When you're done you will have `dist\Dangerzone.msi` - When you're done you will have `dist\Dangerzone.msi`
Rename `Dangerzone.msi` to `Dangerzone $VERSION.msi`. Rename `Dangerzone.msi` to `Dangerzone-$VERSION.msi`.
## Linux release ## Linux release