Johannes/S-dom
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

docs: document publishing process

Browse Source
This commit is contained in:
Johannes Frohnmeyer 2024-05-26 12:07:50 +02:00
parent 48c9158a59
commit fac35b3873
Signed by: Johannes
GPG Key ID: E76429612C2929F4
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -22,10 +22,21 @@ You can download the plugin from the [JetBrains Marketplace](https://plugins.jet
If you want to contribute, feel free to fork the [GitLab repository](https://gitlab.com/JFronny/s-dom) and submit a merge request there. If you want to contribute, feel free to fork the [GitLab repository](https://gitlab.com/JFronny/s-dom) and submit a merge request there.
I'm happy to accept any help, be it bug fixes, new features, or just code cleanup. I'm happy to accept any help, be it bug fixes, new features, or just code cleanup.
Please note that I will merge MRs locally, so don't be surprised if your MR is marked as closed without merging. Please note that I will merge MRs locally, so don't be surprised if your MR is marked as closed without merging.
Also note that S-dom uses Gradle to build but does not use the gradle wrapper, so you should have Gradle installed on your system.
Also take a look at the references below for some resources for developing this plugin.
## References ## References
- [DOMjudge](https://www.domjudge.org/documentation) - [DOMjudge](https://www.domjudge.org/documentation)
- [DOMjudge API](https://domjudge.iti.kit.edu/main/api/doc) - [DOMjudge API](https://domjudge.iti.kit.edu/main/api/doc)
- [SimpleCodeTester plugin](https://github.com/Mr-Pine/SimpleCodeTester-IntelliJ-Plugin) - [SimpleCodeTester plugin](https://github.com/Mr-Pine/SimpleCodeTester-IntelliJ-Plugin)
- [Example Route](https://domjudge.iti.kit.edu/main/api/v4/contests/5/problems) - [Example Route](https://domjudge.iti.kit.edu/main/api/v4/contests/5/problems)
- [All IDEA UI Icons](https://jetbrains.design/intellij/resources/icons_list/) - [All IDEA UI Icons](https://jetbrains.design/intellij/resources/icons_list/)
## Publishing
Note: This section is only relevant for the maintainer of this repository and provided mostly for reference.
To publish a new version, first create a new tag for that version and push it to the repository.
To do so, use the `bumpVersion` task provided by `jf.autoversion` ([source code](https://git.frohnmeyer-wds.de/Johannes/Scripts)) by running `gradle bumpVersion -PnextVersionType=release`.
Then push the tag to the repository using `git push --tags`.
After that, run `gradle buildPlugin -Prelease` to build the plugin. You can find the output of that task as a zip file in the `build/distributions` directory.
Finally, upload the zip file to the JetBrains Marketplace.