📝 Update README, especially regarding update process
This commit is contained in:
parent
a01b3750b4
commit
58b6916db6
1 changed files with 6 additions and 81 deletions
87
README.md
87
README.md
|
@ -1,6 +1,6 @@
|
||||||
# intellij-idea-community
|
# intellij-idea-community
|
||||||
|
|
||||||
.deb Packages of IntelliJ IDEA Community Edition for Ubuntu
|
Debian packages of IntelliJ IDEA Community Edition for Ubuntu
|
||||||
|
|
||||||
I also provide a package for the [Ultimate Edition](https://gitlab.com/mmk2410/intellij-idea-ultimate).
|
I also provide a package for the [Ultimate Edition](https://gitlab.com/mmk2410/intellij-idea-ultimate).
|
||||||
|
|
||||||
|
@ -14,11 +14,13 @@ sudo apt-get install intellij-idea-community
|
||||||
|
|
||||||
## Report issues
|
## 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-community). If relevant, please include which version
|
||||||
|
|
||||||
## Updating the package
|
## 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-community). 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
|
### 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.
|
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"`
|
Run `./update-new-version.sh "$new-version"`
|
||||||
|
|
||||||
Where `$new-version` is in the format `[year].[major].[minor]`.
|
Where `$new-version` is in the format `[year].[major].[minor]`.
|
||||||
|
|
||||||
### The manual way
|
|
||||||
|
|
||||||
To update the version follow these steps. Replace all instances of `[year].[major].[minor]` with the new version numbers (e.g., 2017.3++).
|
|
||||||
|
|
||||||
1. Fork the repo
|
|
||||||
2. Create your own feature branch
|
|
||||||
|
|
||||||
```
|
|
||||||
git checkout -b version-[year].[major].[minor]
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Rename the following
|
|
||||||
|
|
||||||
```
|
|
||||||
mv intellij-idea-community_2017.3 intellij-idea-community_[year].[major].[minor]
|
|
||||||
mv intellij-idea-community_2017.3.orig.tar.gz intellij-idea-community_[year].[major].[minor].orig.tar.gz
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Edit the README.md and update the version numbers
|
|
||||||
|
|
||||||
5. Go into the build files directory
|
|
||||||
|
|
||||||
```
|
|
||||||
cd intellij-idea-community_[year].[major].[minor]/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-community_2017.3-1*
|
|
||||||
```
|
|
||||||
|
|
||||||
12. Install the package to test it
|
|
||||||
|
|
||||||
```
|
|
||||||
sudo dpkg -i intellij-idea-community_[year].[major].[minor]_all.deb
|
|
||||||
```
|
|
||||||
|
|
||||||
13. If everything works, add yourself to the CONTRIBUTORS.txt
|
|
||||||
|
|
||||||
14. Commit your changes
|
|
||||||
|
|
||||||
```
|
|
||||||
git add -A
|
|
||||||
git commit -m "Version [year].[major].[minor]"
|
|
||||||
```
|
|
||||||
|
|
||||||
15. Push to the branch
|
|
||||||
|
|
||||||
```
|
|
||||||
git push origin version-[year].[major].[minor]
|
|
||||||
```
|
|
||||||
|
|
||||||
16. Create new pull request
|
|
||||||
|
|
Loading…
Reference in a new issue