You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
33 lines
1.3 KiB
Plaintext
33 lines
1.3 KiB
Plaintext
bgtex
|
|
|
|
BGTEX schematic and PCB design
|
|
|
|
|
|
DEPENDENCIES
|
|
|
|
- KiCad version 5.1.6 for macOS. Results with previous or subsequent versions
|
|
will likely vary.
|
|
- kipy (https://git.alt-tek.com/alt-tek/kipy) is required to generate board
|
|
plots with plot.py and is thus also required to generate releases
|
|
- tea (https://gitea.com/gitea/tea) is required to generate releases. Install
|
|
and write your API token to ~/.config/git.alt-tek.com/api-token. Restrict
|
|
access to your API token by setting its file permissions accordingly
|
|
(i.e. 'chmod 600 ~/.config/git.alt-tek.com/api-token').
|
|
- In order to generate releases, SSH must be configured for git.alt-tek.com
|
|
such that SSH Git commands can be executed without explicitly specifying an
|
|
SSH identity or private key
|
|
|
|
|
|
RELEASING
|
|
|
|
1. See above dependencies
|
|
2. Create an annotated Git tag for the release commit using
|
|
"git tag -a v<version> -m 'Version <version>' <commit>" where version is the
|
|
board version in X.Y.Z form and <commit> is the commit hash
|
|
(e.g. "git tag -a v1.2.3 -m 'Version 1.2.3' d15c0cafe")
|
|
3. Push the tag upstream (i.e. 'git push origin tags/v<version>')
|
|
4. Use the release script to build the release and upload it as a draft
|
|
(i.e. './release <version>')
|
|
5. Review the release draft. If it is ready for pre-release or production,
|
|
publish it.
|