https://github.com/flytegg/ptero-build-flow

Automatically build and deploy a Gradle or Maven project to a Pterodactyl server instance, and restart it.
https://github.com/flytegg/ptero-build-flow

build ci-cd deploy gradle pterodactyl

Last synced: 3 months ago
JSON representation

Automatically build and deploy a Gradle or Maven project to a Pterodactyl server instance, and restart it.

• Host: GitHub
• URL: https://github.com/flytegg/ptero-build-flow
• Owner: flytegg
• Created: 2023-10-13T13:14:35.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-16T20:36:02.000Z (over 1 year ago)
• Last Synced: 2023-10-17T08:45:37.009Z (over 1 year ago)
• Topics: build, ci-cd, deploy, gradle, pterodactyl
• Homepage:
• Size: 15.6 KB
• Stars: 5
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ptero-build-flow

Automatically build and deploy a Gradle or Maven project to a Pterodactyl server instance, and restart it.

## How to use

### Output jar

Ensure that your output jar is named the same as the repository. For example is your GitHub repository is called "example" then your output jar should be called `example.jar`.

#### For Gradle

To do this with shadowJar, you can add this to your shadowJar task:

```kt

shadowJar {

    archiveFileName.set("example.jar")

    // the rest of your configuration

}

```

#### For Maven

To do this with maven, you can add this to your build inside pom.xml

```xml

    example

```

### Set up repository Actions Secrets & Variables

These can be set up at https://github.com/your-account/your-repository/settings/secrets.

#### Variables

- `PTERO_HOST` - This needs to be the host url of your Pterodactyl panel, e.g. `panel.flyte.gg`

- `PTERO_SERVER_ID` - This needs to be the server id you wish to deploy to, e.g. `c6f88cfb` (the first sector of the UUID)

#### Secrets

- `PTERO_API_KEY` - This is a Client/Account API key, generated at /account/api (not to be mistaken with an Application API key - /admin/api)

### Create new repository from template

You can create a new repository, using this one as a template which will add the required workflow.

If you have an existing repository, look at the next section.

### Add to your repository

The `build.yml` file needs to be at the following location in your repository:

```

.github/workflows/

```

You can rename `build.yml` to whatever you want (in case you have multiple).

### Java Version

If you need, you can change the JDK vendor and version in the "Set up JDK 17" step.