Skip to content

Commit

Permalink
docs(readme): Update title formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
nicokempe authored Sep 1, 2024
1 parent 96803ef commit b963d90
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,58 @@
# 📘 Introduction
### 📘 Introduction

This GitHub Action automates the deployment of Javadoc documentation to GitHub Pages. It builds your Java project, generates Javadoc, and publishes it to a specified branch, typically `gh-pages`.

## ✨ Features
### ✨ Features

- **Automatic Javadoc Generation**: Automatically builds the project and generates Javadoc documentation.
- **Customizable Branch**: Allows publishing of Javadoc to a specified branch (default is `gh-pages`).
- **Flexible JDK Configuration**: Supports multiple JDK versions and distributions, allowing for easy customization.
- **Optional Test Skipping**: Configurable option to skip tests during the build process.
- **Branch Cleanup**: Ability to clean up old branches before publishing, ensuring a fresh deployment environment.

## ⚙️ Inputs
### ⚙️ Inputs

The following inputs can be configured for this action:

### `GITHUB_TOKEN`
#### `GITHUB_TOKEN`
- **Description**: GitHub token used for repository access and authentication.
- **Required**: Yes

### `BRANCH`
#### `BRANCH`
- **Description**: The branch where the Javadoc documentation will be published. Defaults to `'gh-pages'`.
- **Required**: No
- **Default**: `'gh-pages'`

### `BRANCH_CLEANUP`
#### `BRANCH_CLEANUP`
- **Description**: Whether to clean up old branches before publishing. Set to `'true'` to delete the old branch. Defaults to `'false'`.
- **Required**: No
- **Default**: `'false'`

### `JAVA_VERSION`
#### `JAVA_VERSION`
- **Description**: The version of Java your project is using (e.g., `17`).
- **Required**: Yes
- **Default**: `'17'`

### `JAVA_DISTRIBUTION`
#### `JAVA_DISTRIBUTION`
- **Description**: The JDK distribution to use (e.g., `'adopt'`, `'zulu'`). Defaults to `'adopt'`.
- **Required**: No
- **Default**: `'adopt'`

### `SKIP_TESTS`
#### `SKIP_TESTS`
- **Description**: Whether to skip tests during the build process. Set to `'true'` to skip tests.
- **Required**: No
- **Default**: `'false'`

### `DOC_DIRECTORY`
#### `DOC_DIRECTORY`
- **Description**: The directory where the Javadoc documentation is generated. Defaults to `'target/site/apidocs'`.
- **Required**: No
- **Default**: `'target/site/apidocs'`

## 🚀 Usage
### 🚀 Usage

To use this GitHub Action, create a workflow YAML file in your repository's `.github/workflows` directory.

### Example Workflow
#### Example Workflow

Below is an example workflow that builds the project, generates Javadoc, and publishes it to the `gh-pages` branch:

Expand Down Expand Up @@ -85,7 +85,7 @@ jobs:
```
### Example with Branch Cleanup
#### Example with Branch Cleanup
To clean up old branches before publishing, set the `BRANCH_CLEANUP` input to 'true':

Expand Down Expand Up @@ -117,5 +117,5 @@ jobs:
BRANCH_CLEANUP: 'true'
```

## 📄 License
### 📄 License
This project is licensed under the Apache License 2.0 - see the [LICENSE file](https://github.com/DashioDevs/action-javadocs-deploy/blob/main/LICENSE) for details.

0 comments on commit b963d90

Please sign in to comment.