cerus / deploy-helper

deploy-helper is a small tool for artifact deployment targetted at software developers.

Hello there!

My name is Maximilian and I'm a software developer from Germany. I mainly work with Java in combination with Minecraft.

I currently work as a freelancer.

My projects

Minecraft related

• minecraft-place: r/place in Minecraft with live updates (YouTube)
• maps: A Spigot library for drawing stuff on Minecraft maps
• mchr: A Minecraft skin rendering service
• flatcraft: A Spigot plugin that allows you to play a Minecraft clone in your chat (YouTube)
• ...and many others

Other

• edina: A simple stack-oriented compiled programming language
• sharedmem: Shared memory / memory mapped files for Java (Linux + Windows)
• dwordle: Wordle game Discord bot
• hourlycatbot: Mastodon bot that posts cat pictures
• faktor: Tiny & lightweight one-time password (HOTP/TOTP) generation & validation library
• observatorycore-linux: Linux builds for ObservatoryCore
• ...and many others

Contact

Shoot me a message on Discord: cervs (originally Cerus#5149)

For more serious enquiries you can send an email to [email protected].

---

deploy-helper's Issues

Feature: Split Deployer class

The Deployer class is a little big at the moment and it is expected to grow. This will eventually lead to messy code and thats what we are trying to avoid. A solution to this would be to split the class into multiple classes. This is also a great way to get a little more abstraction into the code base.

This is what I imagined:

• Create some sort of task interface with some sort of run method
• execSsh and execCommands will be moved into their respective classes which implement the task interface
• Create instances of the task classes in the Deployer class and call them when needed

I think this would greatly improve the code. If you have any other solution idea please let me know!

Please comment if you would like to work on this.

Feature: Add proper SSH implementation

The current SSH implementation works, but its not great. There's probably a SSH library out there that can do a better job.

Please comment if you would like to work on this.

Make configuration more extendable

Contribution request

Type

• New feature
• Bugfix
• Documentation

Changes

Currently, you are only able to define exactly one SSH config per config file. This is not extendable and will not allow you to define more than one SSH host (for example if you have multiple destinations) with different credentials.

Also the current system does not allow proper extension of deployment tasks as the config relies on SSH and command executions.

Relevant issues

This issue will be worked on together with #5 as it is intuitive to do so.

Add maven wrapper

Contribution request

Type

New feature

Changes

.Add maven wrapper https://maven.apache.org/wrapper/. To be able to run maven if not installed locally

Relevant issues

n/a

Feature: (S)FTP integration

Implement (S)FTP to upload / delete artifacts. The only way to upload artifacts at the moment is through the use of external commands, like Linux's scp, and that's not really great.

I would add an ftp section to the config (like the ssh section) with an instructions array (upload file, delete file, ..). The Destination.Order enum would have to be changed too. The Gson type adapters will also have to be changed and a new type adapter for the ftp section needs to be added.

Please comment if you would like to work on this.

Feature: Add unit tests

The project doesn't contain a single unit test at the moment. I have never written unit tests before so I don't really have a clue how to write good tests.

Please comment if you would like to work on this. Experience with writing (good) unit tests will be needed.

Update to Java 17

Update the project to Java 16 17. Make sure to test everything and to adjust the README.

Comment if you would like to work on this.