https://github.com/codemc/api

The Backend API for the CodeMC Jenkins and Nexus Services
https://github.com/codemc/api

codemc codemc-api java jenkins kotlin nexus

Last synced: 2 months ago
JSON representation

The Backend API for the CodeMC Jenkins and Nexus Services

• Host: GitHub
• URL: https://github.com/codemc/api
• Owner: CodeMC
• License: mit
• Created: 2024-07-23T17:35:01.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-09-26T16:00:16.000Z (3 months ago)
• Last Synced: 2024-09-30T17:42:59.372Z (3 months ago)
• Topics: codemc, codemc-api, java, jenkins, kotlin, nexus
• Language: Kotlin
• Homepage: https://codemc.github.io/API/
• Size: 496 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CodeMC API

This is the official API for CodeMC Jenkins and Nexus services. It is used by the

Discord Bot to do various tasks as a part of our service to our users.

## Installation

[![GitHub branch checks state](https://github.com/CodeMC/API/actions/workflows/build.yml/badge.svg)](https://github.com/gmitch215/SocketMC/actions/workflows/build.yml)

![GitHub](https://img.shields.io/github/license/CodeMC/API)

![GitHub issues](https://img.shields.io/github/issues/CodeMC/API)

    Maven

```xml

    

    

    

    

        

            codemc-public

            https://repo.codemc.io/repository/maven-public/

        

    

    

    

        

          io.codemc.api

          codemc-api

          [VERSION]

        

    

    

```

    Gradle (Groovy)

```gradle

repositories {

    maven { url 'https://repo.codemc.io/repository/maven-public/' }

}

dependencies {

    implementation 'io.codemc.api:codemc-api:[VERSION]'

}

```

    Gradle (Kotlin DSL)

```kotlin

repositories {

    maven(url = "https://repo.codemc.io/repository/maven-public/")

}

dependencies {

    implementation("io.codemc.api:codemc-api:[VERSION]")

}

```

## Local Testing

Test suites rely on both an active services, such as Nexus and Jenkins instances.

Luckily, the project comes with Docker files to set these up yourself.

Without the services, some test suites will fail.

### Test Script (preferred)

A bash script is provided to build the containers and run the tests. This is the easiest way to test the project.

Requires [Docker](https://www.docker.com) to be installed.

```bash

bash .github/test.sh

```

### [Act](https://nektosact.com)

Test the project by using Act, a GitHub Action emulator. This will set up and test everything for you.

```bash

act push -j 'test'

```

### Manual

First, build and run both containers:

```bash

# MariaDB

docker build -t codemc/mariadb src/test/docker/mariadb

docker run -d -p 3306:3306 --name mariadb codemc/mariadb

# Jenkins

docker build -t codemc/jenkins src/test/docker/jenkins

docker run -d -p 8080:8080 --name jenkins-rest codemc/jenkins

# Nexus

docker build -t codemc/nexus src/test/docker/nexus

docker run -d -p 8081:8081 --name nexus-rest codemc/nexus

```

Before running, copy over the `admin.password` file into the `/tmp/` folder so that the API can log in to the newly created Nexus instance.

```bash

docker cp nexus-rest:/nexus-data/admin.password /tmp/admin.password

```

Then, run the tests:

```bash

./gradlew test

```