@@ -6,7 +6,7 @@ Anyway, maybe some things should be a bit more clearly defined so I started this
66document with some pointers for best practices and procedures.
77
88* STYLE *
9- whatever floats your boat. Okay, maybe try to keep it atleast somewhat consistent :)
9+ whatever floats your boat. Okay, maybe try to keep it at least somewhat consistent :)
1010
1111* TOOLS *
1212MusE is highly dependent on Qt, mostly this is a good thing, especially as we want to
@@ -20,37 +20,37 @@ library, do check if Qt can provide the necessary functionality. Many times it c
2020When making a release there are some steps that should always be done to make the
2121packaging consistent and traceable.
2222
23- 1. make sure that version info is updated.
23+ 1. Make sure that version info is updated.
2424 CMakeLists.txt:SET(MusE_VERSION "3.0.0pre1")
2525 CMakeLists.txt:SET(MusE_VERSION_FULL "3.0.0pre1")
2626
27- 2. add a release-line to the ChangeLog (search for old ones for some format hints)
27+ 2. Add a release-line to the ChangeLog (search for old ones for some format hints)
2828
29- 3. commit everything to git
29+ 3. Commit everything to git
3030
31- 4. now create the tarball from the build dir (could be a good idea to create a new build dir)
31+ 4. Now create the tarball from the build dir (could be a good idea to create a new build dir)
3232 $ make clean (otherwise the tarball will way too big)
3333 $ make package_source
3434 feel free to ctrl-c out of this as soon as the .tar.gz build is done as it contines to make
3535 a lot of variants that we do not use.
3636
37- 5. verify that the built package has the right name and can be built
37+ 5. Verify that the built package has the right name and can be built
3838
3939 NOTE: if you are making a point release (e.g. 3.0.1) the file name is based of the path so
4040 the package will be called muse-3.0.tar.gz while it really should be muse-3.0.1. Easiest
4141 way to fix this (for now) is to untar the package, rename the folder (in this case) from
4242 muse-3.0 to muse-3.0.1 and tar it back into muse-3.0.1.tar.gz.
4343
44- 6. make a tag in git for this particular checkin when you are satisfied the release is correct
44+ 6. Make a tag in git for this particular checkin when you are satisfied the release is correct
4545 From 4.0 release we use https://semver.org/ formatted tags.
4646 For instance 4.0 pre release 2 is 4.0.0-pre2.
4747 'git tag -l' lists all of the previous tags.
4848 Use git tag -a <tag name> to create an annotated tag.
4949 To push the tag to master: git push --tags
5050
51- 7. create a releasenote
51+ 7. Create a releasenote
5252
53- 8. upload both releasenote and tarball to the sourceforge page (or whatever is in fashion when
53+ 8. Upload both releasenote and tarball to the sourceforge page (or whatever is in fashion when
5454 it's time).
5555 Update: Currently we upload to both sourceforge (because we always have and it's not a lot of work)
5656 and to the Releases page on github.
@@ -59,6 +59,6 @@ packaging consistent and traceable.
5959 The frontpage is html and resides a specific git repo.
6060 The news page is in the muse github wiki.
6161
62- 10.Update wikipedia to reflect the new release.
62+ 10. Update wikipedia to reflect the new release.
6363
64- 11. send out a release mail
64+ 11. Send out a release mail
0 commit comments