Skip to content

Commit

Permalink
Include current config in generated site.
Browse files Browse the repository at this point in the history
  • Loading branch information
netomi committed Aug 7, 2023
1 parent f7124f1 commit cd44582
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 4 deletions.
15 changes: 11 additions & 4 deletions .github/workflows/build-page.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,21 @@ jobs:
cp -r ../${{ github.repository_owner }}/otterdog/* orgs/${{ github.repository_owner }}
working-directory: otterdog-configs

- name: Generate current configuration as markdown
run: ../otterdog/otterdog.sh show ${{ github.repository_owner }} -c otterdog.json --markdown --output-dir generated-site
working-directory: otterdog-configs

- name: Generate default configuration as markdown
run: ../otterdog/otterdog.sh show-default ${{ github.repository_owner }} -c otterdog.json --markdown > default.txt
working-directory: otterdog-configs

- name: Upload default text snippet
- name: Upload generated site content
uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3
with:
name: default-text
path: otterdog-configs/default.txt
name: generated-site
path: |
otterdog-configs/default.txt
otterdog-configs/generated-site/
build-page:
runs-on: ubuntu-latest
Expand All @@ -85,10 +91,11 @@ jobs:
- name: Download default-text
uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3
with:
name: default-text
name: generated-site
- shell: bash
run: |
cat default.txt >> ./docs/index.md
cp generated-site/*.md ./docs/
- uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4
with:
python-version: 3.x
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ hide:

General documentation for using the self-service (stored in directory *otterdog*) can be accessed at [otterdog.readthedocs.io](https://otterdog.readthedocs.io).

## Current configuration

The current configuration can be reviewed [here](configuration.md).

## Default values

The following snippets illustrate the default values that are inherited from the [default configuration](https://github.com/EclipseFdn/otterdog-defaults/blob/main/otterdog-defaults.libsonnet)
Expand Down
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ markdown_extensions:
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg

plugins: []
nav: []
Expand Down

0 comments on commit cd44582

Please sign in to comment.