📝 Update README, especially regarding update process

This commit is contained in:
Marcel Kapfer 2023-03-13 23:00:06 +01:00
parent ce91289f14
commit 5cc1013813
Signed by: mmk2410
GPG key ID: CADE6F0C09F21B09

View file

@ -1,6 +1,6 @@
# intellij-idea-ultimate
.deb Packages of IntelliJ IDEA Ultimate Edition for Ubuntu / Debian.
Debian packages of IntelliJ IDEA Ultimate Edition for Ubuntu / Debian.
I also provide a package for the [Community Edition](https://gitlab.com/mmk2410/intellij-idea-community).
@ -14,11 +14,13 @@ sudo apt-get install intellij-idea-ultimate
## Report issues
You can report issues, questions or feedback concerning the package here on GitLab. Please include which version your using.
You can report issues, questions or feedback concerning the package [on GitLab](https://gitlab.com/mmk2410/intellij-idea-ultimate). If relevant, please include which version your using.
## Updating the package
To update the package the first you need to do is to set up your build environment. After that there are two ways: an automated way (which is highly preferred) and a manual way.
Since I automated the updating process quite a bit using the `update-new-version.sh` as well as preparations on my local system I no longer accept merge requests for updating the package to a new version. Processing them would take me much more time than doing the update myself.
In case I'm late for an update (over 1-2 weeks), feel free to create an issue [on GitLab](https://gitlab.com/mmk2410/intellij-idea-ultimate). I'm also working on a fully automated system for updating the packages but this will still take a while.
### Setting up the build environment
@ -26,85 +28,8 @@ Run `sudo apt install build-dep debhelper`.
It is also necessary to setup Git with your username and email address as explained in numerous tutorials.
### The automated way
### Updating the package
Run `./update-new-version.sh "$new-version"`
Where `$new-version` is in the format `[year].[major].[minor]`.
### The manual way
To update the version follow the following steps (the old version is here 15.0.1 and the new one 15.0.2):
1. Fork the repo
2. Create your own feature branch
git checkout -b version_15.0.2
3. Rename the following
mv intellij-idea-ultimate_15.0.1 intellij-idea-ultimate_15.0.2
mv intellij-idea-ultimate_15.0.1.orig.tar.gz intellij-idea-ultimate_15.0.2.orig.tar.gz
4. Edit the README.md and update the version numbers
5. Go into the build files directory
cd intellij-idea-ultimate_15.0.2/debian
6. Edit the changelog file and prepend a new changelog entry. You can just copy an old one and update the values in it
7. Edit the preinst file and update the download URL. Normally this is done by updating the version number
8. Go one directory back
cd ..
9. Run the following command to build the package for testing purposes
debuild -us -uc
10. Go another directory back
cd ..
11. Remove the old files
rm intellij-idea-ultimate_15.0.1-1*
12. Install the package to test it
sudo dpkg -i intellij-idea-ultimate_15.0.2-1_all.deb
13. If everything works, add yourself to the CONTRIBUTORS.txt
14. Commit your changes
git add -A
git commit -m "Version 15.0.2"
15. Push to the branch
git push origin version_15.0.2
16. Create new pull request