|
|
# Release-howto
|
|
|
|
|
|
Short notes about how to make a release, for a kernel-related project
|
|
|
that is hosted in ohwr.org.
|
|
|
|
|
|
## Before you start
|
|
|
|
|
|
- Ensure to be in the proper package clone
|
|
|
|
|
|
<!-- end list -->
|
|
|
|
|
|
- Ensure to be in the proper commit and that master is there.
|
|
|
|
|
|
<!-- end list -->
|
|
|
|
|
|
- Check the date in the manual
|
|
|
|
|
|
<!-- end list -->
|
|
|
|
|
|
- Ensure both the software and the manual build properly
|
|
|
|
|
|
<!-- end list -->
|
|
|
|
|
|
- Think hard and check TODO files about any pending bugs
|
|
|
|
|
|
<!-- end list -->
|
|
|
|
|
|
- Build for all versions, checking the backport branch
|
|
|
|
|
|
If all of this is ok, you can release.
|
|
|
|
|
|
## How to tag and clean the repository
|
|
|
|
|
|
- Consider marking the tag in the manual, but if there is a backport
|
|
|
evaluate the effort (i.e., I don't do it usually)
|
|
|
|
|
|
\* Check other tags. Example:
|
|
|
|
|
|
```
|
|
|
git cat-file tag fmc-bus-v2013-01
|
|
|
```
|
|
|
|
|
|
\* Tag consistently with other tags in the same package, with -m.
|
|
|
Example:
|
|
|
|
|
|
```
|
|
|
git tag -m "Official release as of May 2013" fmc-bus-v2013-05
|
|
|
```
|
|
|
|
|
|
\* "git describe master" to ensure it's ok. Then push
|
|
|
|
|
|
```
|
|
|
git push ohwr fmc-bus-v2013-05
|
|
|
```
|
|
|
|
|
|
- Remove other temporary branches with the same commit, and older
|
|
|
temporaries
|
|
|
|
|
|
\* Push the current backport with a name consistent with previous ones.
|
|
|
E.g:
|
|
|
|
|
|
```
|
|
|
git branch -m proposed-v2013.05-backport fmc-bus-v2013-05-backport
|
|
|
git push ohwr fmc-bus-v2013-05-backport
|
|
|
git push ohwr :proposed-v2013.05-backport
|
|
|
```
|
|
|
|
|
|
## Other Housekeeping Tasks
|
|
|
|
|
|
- Post the pdf to files or documents as it is tradition in this
|
|
|
package
|
|
|
Remember to check the descriptive string before to be consistent,
|
|
|
as
|
|
|
when you type it in the "add" windows you can't check the other
|
|
|
ones.
|
|
|
|
|
|
\* If customary for this package, make a tarball
|
|
|
|
|
|
\* go to /tmp
|
|
|
|
|
|
\* clone from the read-only ohwr place
|
|
|
|
|
|
\* rename to the name you want it to have when tarred
|
|
|
|
|
|
\* build the manual ("make -C doc", most likely)
|
|
|
|
|
|
\* maketar.gz, i.e. as follows, or equivalent for another compression:
|
|
|
|
|
|
```
|
|
|
n=`basename \`/bin/pwd\``; cd ..; tar cvf - $n | gzip > $n.tar.gz
|
|
|
```
|
|
|
|
|
|
- If you marked the release name in the manual, re-commit
|
|
|
immediately
|
|
|
the manual so that is it not blessed any more.
|
|
|
|
|
|
<!-- end list -->
|
|
|
|
|
|
- Write a news item on ohwr
|
|
|
|
|
|
<!-- end list -->
|
|
|
|
|
|
- Update the ohwr main wiki page to reflect status
|
|
|
|
|
|
## Done
|
|
|
|
|
|
- Rest in peace
|
|
|
|