Compare commits

...
37 Commits
Author SHA1 Message Date
buildmaster 7ef02395ca Update SNAPSHOT to 4.1.2 2024-05-30 10:06:52 +00:00
Ryan Baxter bc9b9ea339 Create antora-playbook-template.yml 2024-04-09 10:55:37 -04:00
Ryan Baxter 6a8fb125de Update spring-cloud-deploy-docs.yml 2024-04-09 09:48:58 -04:00
Ryan Baxter 746bb19f07 Update spring-cloud-deploy-docs.yml 2024-04-09 09:47:32 -04:00
Ryan Baxter e6d9d44e78 Update spring-cloud-deploy-docs.yml 2024-04-09 09:45:09 -04:00
Ryan Baxter 565c6f4f02 Update spring-cloud-deploy-docs.yml 2024-04-09 09:38:32 -04:00
Ryan Baxter 8f5a10db73 Update spring-cloud-deploy-docs.yml 2024-04-09 09:36:46 -04:00
Ryan Baxter d31215b3c7 Update spring-cloud-deploy-docs.yml 2024-04-09 09:23:45 -04:00
Ryan Baxter 2570f39a88 Update deploy-docs-test.yml 2024-04-05 17:08:34 -04:00
Ryan Baxter e016f18d74 Create deploy-docs-test.yml 2024-04-05 17:06:43 -04:00
Ryan Baxter 8c14536ffc Create spring-cloud-deploy-docs.yml 2024-04-05 17:02:07 -04:00
Ryan Baxter f011bee813 Update antora-playbook.yml 2024-04-04 14:19:30 -04:00
buildmaster 025defee84 Bumping versions 2024-03-27 19:22:06 +00:00
Ryan Baxter 7b48b2b8e9 Merge pull request #246 from cxhello/patch-2
fix: update contributing.adoc error link
2024-03-27 09:46:12 -04:00
buildmaster 57f3dc6a1d Bumping versions to 4.1.2-SNAPSHOT after release 2024-03-27 12:33:12 +00:00
buildmaster 6f548ec691 Going back to snapshots 2024-03-27 12:33:12 +00:00
buildmaster 2ec044f1ac Update SNAPSHOT to 4.1.1 2024-03-27 12:31:50 +00:00
cxhello b756d43a94 fix: update contributing.adoc error link 2024-03-27 08:44:39 +08:00
buildmaster 4737e7405d Bumping versions 2024-03-26 20:12:50 +00:00
Ryan Baxter a884a9f6a8 Merge pull request #245 from cxhello/patch-1 2024-03-26 11:01:07 -04:00
cxhello 7144bfa34c fix: update README.adoc error link 2024-03-26 16:39:05 +08:00
Ryan Baxter 6efd154432 Update antora-playbook.yml to 0.4.11 2024-03-12 10:30:46 -04:00
buildmaster b0fef38e3e Bumping versions 2024-03-05 16:50:20 +00:00
Ryan Baxter ad732419fc Delete docs/src/main/asciidoc/contributing-docs.adoc 2023-12-19 11:03:49 -05:00
Ryan Baxter b5c7c50600 Create contributing-docs.adoc 2023-12-19 10:38:36 -05:00
buildmaster 6dac40322d Going back to snapshots 2023-12-06 14:30:48 +00:00
buildmaster 94bea8dec6 Update SNAPSHOT to 4.1.0 2023-12-06 14:29:30 +00:00
buildmaster 112414c6c8 Bumping versions to 4.1.1-SNAPSHOT after release 2023-12-06 14:07:27 +00:00
buildmaster 9dc6a2cd25 Going back to snapshots 2023-12-06 14:07:27 +00:00
buildmaster b5a2cd3f8a Update SNAPSHOT to 4.1.0 2023-12-06 14:06:05 +00:00
buildmaster e54745b14a Bumping versions 2023-11-28 20:18:55 +00:00
buildmaster 2cdd4e5995 Going back to snapshots 2023-10-31 12:49:43 +00:00
buildmaster 893884976c Update SNAPSHOT to 4.1.0-RC1 2023-10-31 12:48:29 +00:00
buildmaster 2e71bd2d16 Going back to snapshots 2023-09-27 09:43:10 +00:00
buildmaster 29656eecf3 Update SNAPSHOT to 4.1.0-M2 2023-09-27 09:41:33 +00:00
Marcin Grzejszczak bbfef2f3e2 Not running config-props using the spring-cloud-build-docs dep 2023-09-26 14:17:17 +02:00
Marcin Grzejszczak 69195e8210 Added kroki to antora packages
With this change if you want to use diagrams you can easily do that
2023-09-25 16:52:33 +02:00
11 changed files with 104 additions and 17 deletions
+15
View File
@@ -0,0 +1,15 @@
name: Deploy Docs Test
on:
push:
branches-ignore: [ gh-pages ]
tags: '**'
repository_dispatch:
types: request-build-reference # legacy
#schedule:
#- cron: '0 10 * * *' # Once per day at 10am UTC
workflow_dispatch:
jobs:
deploy-docs:
uses: spring-cloud/spring-cloud-build/.github/workflows/spring-cloud-deploy-docs.yml@main
secrets: inherit
@@ -0,0 +1,29 @@
name: Spring Cloud Deploy Docs
on:
workflow_call:
permissions:
actions: write
jobs:
build:
runs-on: ubuntu-latest
# FIXME: enable when pushed to spring-projects
# if: github.repository_owner == 'spring-projects'
steps:
- name: Checkout
uses: actions/checkout@v3
with:
ref: docs-build
fetch-depth: 1
# TODO: Do we need these two below jobs? They don't appear to do much when they run
- name: Dispatch (partial build)
if: github.ref_type == 'branch'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD) -f build-refname=${{ github.ref_name }}
- name: Dispatch (full build)
if: github.ref_type == 'tag'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD)
+3 -3
View File
@@ -213,13 +213,13 @@ The following files can be found in the https://github.com/spring-cloud/spring-c
.Code style
image::intellij-code-style.png[Code style]
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/assets/images/intellij-code-style.png[Code style]
Go to `File` -> `Settings` -> `Editor` -> `Code style`. There click on the icon next to the `Scheme` section. There, click on the `Import Scheme` value and pick the `Intellij IDEA code style XML` option. Import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file.
.Inspection profiles
image::intellij-inspections.png[Code style]
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/assets/images/intellij-inspections.png[Code style]
Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon next to the `Profile` section. There, click on the `Import Profile` and import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file.
@@ -227,7 +227,7 @@ Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon
To have Intellij work with Checkstyle, you have to install the `Checkstyle` plugin. It's advisable to also install the `Assertions2Assertj` to automatically convert the JUnit assertions
image::intellij-checkstyle.png[Checkstyle]
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/assets/images/intellij-checkstyle.png[Checkstyle]
Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables:
+40
View File
@@ -0,0 +1,40 @@
antora:
extensions:
- '@springio/antora-extensions/partial-build-extension'
# atlas-extension must be before latest-version-extension so latest versions are applied to imported versions
- '@antora/atlas-extension'
- require: '@springio/antora-extensions/latest-version-extension'
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
- '@antora/collector-extension'
- require: '@springio/antora-extensions/root-component-extension'
root_component_name: 'cloud-build'
- '@springio/antora-extensions/static-page-extension'
site:
title: {{ .site_title }}
url: {{ .site_ url }}
content:
sources:
- url: ./..
branches: HEAD
start_path: docs
worktrees: true
asciidoc:
attributes:
page-stackoverflow-url: https://stackoverflow.com/tags/spring-cloud
page-pagination: ''
hide-uri-scheme: '@'
tabs-sync-option: '@'
chomp: 'all'
extensions:
- '@asciidoctor/tabs'
- '@springio/asciidoctor-extensions'
sourcemap: true
urls:
latest_version_segment: ''
runtime:
log:
failure_level: warn
format: pretty
ui:
bundle:
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.11/ui-bundle.zip
+3 -2
View File
@@ -1,10 +1,11 @@
antora:
extensions:
- '@springio/antora-extensions/partial-build-extension'
# atlas-extension must be before latest-version-extension so latest versions are applied to imported versions
- '@antora/atlas-extension'
- require: '@springio/antora-extensions/latest-version-extension'
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
- '@antora/collector-extension'
- '@antora/atlas-extension'
- require: '@springio/antora-extensions/root-component-extension'
root_component_name: 'cloud-build'
- '@springio/antora-extensions/static-page-extension'
@@ -36,4 +37,4 @@ runtime:
format: pretty
ui:
bundle:
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.2/ui-bundle.zip
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.11/ui-bundle.zip
+3 -3
View File
@@ -162,13 +162,13 @@ The following files can be found in the https://github.com/spring-cloud/spring-c
.Code style
image::intellij-code-style.png[Code style]
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/assets/images/intellij-code-style.png[Code style]
Go to `File` -> `Settings` -> `Editor` -> `Code style`. There click on the icon next to the `Scheme` section. There, click on the `Import Scheme` value and pick the `Intellij IDEA code style XML` option. Import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file.
.Inspection profiles
image::intellij-inspections.png[Code style]
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/assets/images/intellij-inspections.png[Code style]
Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon next to the `Profile` section. There, click on the `Import Profile` and import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file.
@@ -176,7 +176,7 @@ Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon
To have Intellij work with Checkstyle, you have to install the `Checkstyle` plugin. It's advisable to also install the `Assertions2Assertj` to automatically convert the JUnit assertions
image::intellij-checkstyle.png[Checkstyle]
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/assets/images/intellij-checkstyle.png[Checkstyle]
Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables:
+2 -1
View File
@@ -10,7 +10,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build</artifactId>
<version>4.1.0-SNAPSHOT</version>
<version>4.1.2</version>
</parent>
<properties>
<docs.main>spring-cloud-build</docs.main>
@@ -18,6 +18,7 @@
<!-- We don't want to downloaded sources of our own project-->
<maven-dependency-plugin-for-docs.phase>none</maven-dependency-plugin-for-docs.phase>
<maven-dependency-plugin-for-docs-classes.phase>none</maven-dependency-plugin-for-docs-classes.phase>
<generate-cloud-resources.phase>none</generate-cloud-resources.phase>
<docs.resources.dir>${project.basedir}/src/main/</docs.resources.dir>
<!-- Don't upload docs jar to central / repo.spring.io -->
<!-- TODO: temporary, don't want it to central? -->
+4 -3
View File
@@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build</artifactId>
<version>4.1.0-SNAPSHOT</version>
<version>4.1.2</version>
<packaging>pom</packaging>
<name>Spring Cloud Parent</name>
<description>Spring Cloud parent pom, managing plugins and dependencies for Spring
@@ -28,8 +28,8 @@
<maven.compiler.target>${java.version}</maven.compiler.target>
<main.basedir>${basedir}</main.basedir>
<docs.main>${project.artifactId}</docs.main>
<spring-boot.version>3.2.0-SNAPSHOT</spring-boot.version>
<spring-cloud-build.version>4.1.0-SNAPSHOT</spring-cloud-build.version>
<spring-boot.version>3.2.6</spring-boot.version>
<spring-cloud-build.version>4.1.2</spring-cloud-build.version>
<docs.resources.dir>${project.build.directory}/build-docs</docs.resources.dir>
<docs.classes.dir>${project.build.directory}/build-docs-classes</docs.classes.dir>
<refdocs.build.directory>${project.build.directory}/refdocs/</refdocs.build.directory>
@@ -1080,6 +1080,7 @@
<package>@asciidoctor/tabs@1.0.0-beta.3</package>
<package>@springio/antora-extensions@1.6.0</package>
<package>@springio/asciidoctor-extensions@1.0.0-alpha.9</package>
<package>asciidoctor-kroki@0.17.0</package>
</packages>
</configuration>
<executions>
+3 -3
View File
@@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build-dependencies</artifactId>
<version>4.1.0-SNAPSHOT</version>
<version>4.1.2</version>
<name>spring-cloud-build-dependencies</name>
<packaging>pom</packaging>
<description>Spring Cloud Build Dependencies: an internal BOM for use with Spring
@@ -14,12 +14,12 @@
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>3.2.0-SNAPSHOT</version>
<version>3.2.6</version>
<relativePath/>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<spring-boot.version>3.2.0-SNAPSHOT</spring-boot.version>
<spring-boot.version>3.2.6</spring-boot.version>
<maven-gpg-plugin.version>3.0.1</maven-gpg-plugin.version>
</properties>
<build>
+1 -1
View File
@@ -10,7 +10,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build</artifactId>
<version>4.1.0-SNAPSHOT</version>
<version>4.1.2</version>
</parent>
<dependencies>
<dependency>
+1 -1
View File
@@ -4,7 +4,7 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.cloud</groupId>
<version>4.1.0-SNAPSHOT</version>
<version>4.1.2</version>
<artifactId>spring-cloud-dependencies-parent</artifactId>
<packaging>pom</packaging>
<name>spring-cloud-dependencies-parent</name>