Added pages GitHub workflow

This commit is contained in:
Erik C. Thauvin 2023-04-04 09:36:50 -07:00
parent 753f3bcf45
commit 38c68da203
3 changed files with 69 additions and 6 deletions

57
.github/workflows/pages.yml vendored Normal file
View file

@ -0,0 +1,57 @@
name: javadocs-pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout source repository
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 17
- name: Build Javadocs
run: ./bld download clean javadoc
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload generated Javadocs repository
path: 'build/javadoc/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1

View file

@ -4,7 +4,7 @@
[![Java](https://img.shields.io/badge/java-17%2B-blue)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
[![GitHub CI](https://github.com/rife2/bld-property-file/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-property-file/actions/workflows/bld.yml)
An extension for creating or modifying [property files](https://docs.oracle.com/javase/tutorial/essential/environment/properties.html) with [bld](https://github.com/rife2/rife2/wiki/What-Is-Bld). It is inspired by the [ant PropertyFile task](https://ant.apache.org/manual/Tasks/propertyfile.html).
A `bld` extension for creating or modifying [property files](https://docs.oracle.com/javase/tutorial/essential/environment/properties.html) with [bld](https://github.com/rife2/rife2/wiki/What-Is-Bld). It is inspired by the [ant PropertyFile task](https://ant.apache.org/manual/Tasks/propertyfile.html).
```java
@BuildCommand

View file

@ -11,16 +11,21 @@ import java.util.List;
import static rife.bld.dependencies.Repository.*;
import static rife.bld.dependencies.Scope.compile;
import static rife.bld.dependencies.Scope.test;
import static rife.bld.operations.JavadocOptions.DocLinkOption.NO_MISSING;
public class PropertyFileBuild extends Project {
public PropertyFileBuild() {
pkg = "rife.bld.extension";
name = "bld-property-file";
version = version(0, 9, 0);
javadocOptions.add("-Xdoclint:-missing");
javadocOptions
.docLint(NO_MISSING)
.link("https://rife2.github.io/rife2/");
publishRepository = MAVEN_LOCAL;
publishInfo = new PublishInfo().groupId("com.uwyn.rife2").artifactId("bld-property-file")
.description("Bld Extension to Create or Modify Properties Files")
publishInfo = new PublishInfo()
.groupId("com.uwyn.rife2")
.artifactId("bld-property-file")
.description("bld Extension to Create or Modify Properties Files")
.url("https://github.com/rife2/bld-property-file")
.developer(new PublishDeveloper().id("ethauvin").name("Erik C. Thauvin").email("erik@thauvin.net")
.url("https://erik.thauvin.net/"))
@ -33,9 +38,10 @@ public class PropertyFileBuild extends Project {
.url("https://github.com/rife2/bld-property-file"));
javaRelease = 17;
downloadSources = true;
repositories = List.of(MAVEN_CENTRAL, SONATYPE_SNAPSHOTS);
autoDownloadPurge = true;
repositories = List.of(MAVEN_CENTRAL, RIFE2);
scope(compile)
.include(dependency("com.uwyn.rife2", "rife2", version(1, 5, 15)));
scope(test)