Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 0 additions & 34 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,40 +69,6 @@ jobs:
- name: build with maven
run: mvn -B formatter:validate verify --file pom.xml "-Djava17.home=${{env.JAVA_HOME_17_X64}}" "-Djava21.home=${{env.JAVA_HOME_21_X64}}" "-Djava25.home=${{env.JAVA_HOME_25_X64}}"

docs:
needs: [build]
if: github.event_name == 'push' && github.repository_owner == 'smallrye'
runs-on: ubuntu-latest
name: docs

steps:
- uses: actions/checkout@v7
name: checkout

- uses: actions/setup-java@v6
with:
distribution: 'temurin'
java-version: 25
cache: 'maven'
cache-dependency-path: '**/pom.xml'

- uses: actions/setup-python@v7
with:
python-version: '3.12'

- name: build docs
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
run: |
cd documentation
mvn package
pipx install pipenv
pipenv install --ignore-pipfile
git fetch origin gh-pages --depth=1
git config --global user.name "SmallRye CI"
git config --global user.email "smallrye@googlegroups.com"
pipenv run mike deploy --config-file=mkdocs.yaml --push --update-aliases Main SNAPSHOT

quality:
needs: [build]
if: github.event_name == 'push' && github.repository_owner == 'smallrye'
Expand Down
16 changes: 16 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Documentation

# Renders the documentation with the smallrye.io site, as it will be published, and fails on a
# broken include or a page that does not render. smallrye.io publishes main nightly and each release.
on:
pull_request:
paths:
- 'documentation/**'
- '.github/workflows/docs.yml'
workflow_dispatch:

jobs:
docs:
uses: smallrye/smallrye.github.io/.github/workflows/docs-check.yml@develop
with:
project: smallrye-config
48 changes: 0 additions & 48 deletions .github/workflows/publish-docs.yml

This file was deleted.

7 changes: 0 additions & 7 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,6 @@ jobs:
with:
version: ${{github.event.inputs.tag || github.ref_name}}

publish-docs:
name: Publish Docs
uses: ./.github/workflows/publish-docs.yml
secrets: inherit
with:
version: ${{github.event.inputs.tag || github.ref_name}}

publish-tck:
name: Publish TCK Report
uses: ./.github/workflows/publish-tck.yml
Expand Down
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,5 @@ client/shade/dependency-reduced-pom.xml
# Jenv
.java-version

# MkDocs
site

# formatter cache directories
.cache
13 changes: 4 additions & 9 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,9 @@ Compile and test the project:
mvn verify
----

Generate the documentation (from the `documentation` folder):

[source,bash]
----
mvn package
pipenv install
pipenv run mkdocs serve
----
The documentation is AsciiDoc in `documentation/src/main/asciidoc`, published on
https://smallrye.io/docs/smallrye-config/latest/[smallrye.io]. See `documentation/README.adoc` to
write and preview it.

=== Project structure

Expand All @@ -56,4 +51,4 @@ Please refer to our Wiki for the https://github.com/smallrye/smallrye/[Contribut

* http://github.com/smallrye/smallrye-config/[Project Homepage]
* {microprofile-config}[Eclipse MicroProfile Config]
* https://smallrye.io/smallrye-config[Documentation]
* https://smallrye.io/docs/smallrye-config/latest/[Documentation]
15 changes: 0 additions & 15 deletions documentation/Pipfile

This file was deleted.

Loading
Loading