Skip to content

Commit

Permalink
Merge branch 'manager-4.3' into manager43-iau-proxy-spbase-#2930-keichwa
Browse files Browse the repository at this point in the history
  • Loading branch information
keichwa authored Apr 17, 2024
2 parents 1a402eb + 7badc27 commit b868934
Show file tree
Hide file tree
Showing 44 changed files with 3,711 additions and 5,100 deletions.
1 change: 1 addition & 0 deletions .changelog
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

- Changed Proxy base version number in the installation from packages
description to version 15.4
- Removed Debian 10 from the list of supported clients
- Added new workflow describing updating of clients using recurring actions
to Commown Workflows
- Added documentation on adding a storage device for VMWare
Expand Down
62 changes: 62 additions & 0 deletions .github/workflows/build_and_archive_devel_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Build and archive documentation from development branches

on:
push:
branches:
- 'master' # Only master will build both Uyuni and SUSE Manager documentations
- 'manager-4.3' # Other branches will only build SUSE Manager documentation
workflow_run:
workflows: ["Update translation files"] # This workflow creates commits, so we need to run after a successful run
types:
- completed

jobs:
run:
runs-on: ubuntu-latest

steps:
- name: Checkout this repository
uses: actions/checkout@v4
with:
path: uyuni-docs

- name: Checkout uyuni-docs-helper repository
uses: actions/checkout@v4
with:
path: uyuni-docs-helper
repository: uyuni-project/uyuni-docs-helper

- name: Configure environment
run: |
alias docker='podman'
mkdir outputs
- name: Build the Uyuni documentation
run: |
cd uyuni-docs-helper
./uyuni-docs-helper -r ${{ github.ref_name }} -g https://github.com/${{ github.repository}}.git -o /tmp -c antora-uyuni-en -p uyuni
cd ..
mkdir ./uyuni # Required so the folder name is included later in the archive
cp -r /tmp/build ./uyuni/uyuni
if: github.ref_name == 'master'

- name: Archive Uyuni Documentation
uses: actions/upload-artifact@v4
with:
name: documentation-uyuni-${{ github.ref_name }}
path: uyuni/
if: github.ref_name == 'master'

- name: Build the SUSE Manager documentation
run: |
cd uyuni-docs-helper
./uyuni-docs-helper -r ${{ github.ref_name }} -g https://github.com/${{ github.repository}}.git -o /tmp -c antora-suma-en -p suma
cd ..
mkdir ./susemanager # Required so the folder name is included later in the archive
cp -r /tmp/build ./susemanager/susemanager
- name: Archive SUSE Manager Documentation
uses: actions/upload-artifact@v4
with:
name: documentation-susemanager-${{ github.ref_name }}
path: susemanager/
107 changes: 107 additions & 0 deletions .github/workflows/build_and_archive_release_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
name: Build and archive documentation from release branches

on:
push:
branches:
- 'uyuni-20[0-9][0-9].[0-9][0-9]' # Only master will build both Uyuni and SUSE Manager documentations
- 'manager-4.3-MU-4.3.[0-9][0-9]?' # Other branches will only build SUSE Manager documentation
- 'manager-5.0-alpha[0-9]' # Other branches will only build SUSE Manager documentation
- 'manager-5.0-beta[0-9]' # Other branches will only build SUSE Manager documentation
- 'manager-5.0-rc[0-9]' # Other branches will only build SUSE Manager documentation
- 'manager-5.0-gmc[0-9]' # Other branches will only build SUSE Manager documentation
- 'manager-5.0-gm' # Other branches will only build SUSE Manager documentation

jobs:
run:
runs-on: ubuntu-latest

steps:
- name: Checkout this repository
uses: actions/checkout@v4
with:
path: uyuni-docs

- name: Checkout uyuni-docs-helper repository
uses: actions/checkout@v4
with:
path: uyuni-docs-helper
repository: uyuni-project/uyuni-docs-helper

- name: Configure environment
run: |
alias docker='podman'
mkdir outputs
- name: Build the Uyuni site documentation
run: |
rm -rf ./uyuni # Always clean before building
cd uyuni-docs-helper
./uyuni-docs-helper -r ${{ github.ref_name }} -g https://github.com/${{ github.repository}}.git -o /tmp -c antora-uyuni -p uyuni
cd ..
mkdir ./uyuni # Required so the folder name is included later in the archive
cp -r /tmp/build ./uyuni/uyuni-site
if: startsWith(github.ref_name, 'uyuni-')

- name: Archive Uyuni site Documentation
uses: actions/upload-artifact@v4
with:
name: documentation-uyuni-site-${{ github.ref_name }}
path: uyuni/
if: startsWith(github.ref_name, 'uyuni-')

- name: Build the Uyuni package documentation
run: |
rm -rf ./uyuni # Always clean before building
cd uyuni-docs-helper
./uyuni-docs-helper -r ${{ github.ref_name }} -g https://github.com/${{ github.repository}}.git -o /tmp -c obs-packages-uyuni -p uyuni
cd ..
mkdir ./uyuni # Required so the folder name is included later in the archive
cp -r /tmp/build/packages ./uyuni/uyuni-package
if: startsWith(github.ref_name, 'uyuni-')

- name: Archive Uyuni package Documentation
uses: actions/upload-artifact@v4
with:
name: documentation-uyuni-package-${{ github.ref_name }}
path: uyuni/
if: startsWith(github.ref_name, 'uyuni-')

- name: Build the SUSE Manager site documentation
run: |
rm -rf ./susemanager # Always clean before building
cd uyuni-docs-helper
./uyuni-docs-helper -r ${{ github.ref_name }} -g https://github.com/${{ github.repository}}.git -o /tmp -c antora-suma -p suma
cd ..
mkdir ./susemanager # Required so the folder name is included later in the archive
cp -r /tmp/build ./susemanager/susemanager-site
if: startsWith(github.ref_name, 'manager-')

- name: Archive SUSE Manager site Documentation
uses: actions/upload-artifact@v4
with:
name: documentation-susemanager-site-${{ github.ref_name }}
path: susemanager/
if: startsWith(github.ref_name, 'manager-')

- name: Build the SUSE Manager package documentation (only english)
run: |
rm -rf ./susemanager # Always clean before building
cd uyuni-docs-helper
./uyuni-docs-helper -r ${{ github.ref_name }} -g https://github.com/${{ github.repository}}.git -o /tmp -c obs-packages-suma-en -p suma
cd ..
mkdir ./susemanager # Required so the folder name is included later in the archive
cp -r /tmp/build/packages/ ./susemanager/susemanager-package
if: startsWith(github.ref_name, 'manager-')

- name: Archive SUSE Manager package Documentation (only english)
uses: actions/upload-artifact@v4
with:
name: documentation-susemanager-package-${{ github.ref_name }}
path: susemanager/
if: startsWith(github.ref_name, 'manager-')

- name: Archive the changelog
uses: actions/upload-artifact@v4
with:
name: changelog
path: uyuni-docs/CHANGELOG.md
18 changes: 18 additions & 0 deletions .github/workflows/enforced_checkstyle.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# We keep this workflow without using uyuni-docs-helper as it interacts directly with the repository
name: Enforced checkstyle

# Launch manually. It is broken for now and we do not want to spam contributors
on: workflow_dispatch

jobs:
run:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v4

- name: Check ifeval syntax
run: find -name "*\.adoc" -type f | xargs -I {} ./enforcing_checkstyle --filename {} --ifeval

- name: Check comments on nav file
run: find -name "nav*\.adoc" -type f | xargs -I {} ./enforcing_checkstyle --filename {} --comment
16 changes: 0 additions & 16 deletions .github/workflows/enforcing_checkstyle.yml

This file was deleted.

58 changes: 0 additions & 58 deletions .github/workflows/feature_tests_uyuni.yml

This file was deleted.

13 changes: 0 additions & 13 deletions .github/workflows/find_unused.yml

This file was deleted.

13 changes: 13 additions & 0 deletions .github/workflows/find_unused_files.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# We keep this workflow without using uyuni-docs-helper as it interacts directly with the repository
name: Find unused files
on: push

jobs:
run:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v4

- name: Look for unused files
run: ./find_unused administration client-configuration common-workflows installation-and-upgrade quickstart reference retail specialized-guides
17 changes: 12 additions & 5 deletions .github/workflows/vale_tests.yml → .github/workflows/linting.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,38 @@
# We keep this workflow without using uyuni-docs-helper as it interacts directly with the repository
name: Linting
on: [push]

# Launch manually. It is broken for now and we do not want to spam contributors
on: workflow_dispatch

jobs:
prose:
runs-on: ubuntu-latest

steps:
- name: '[CHECKOUT] Checkout branch that triggered this workflow'
uses: actions/checkout@v3
- name: 'Checkout branch that triggered this workflow'
uses: actions/checkout@v4

- name: '[TOOLCHAIN] Set up Ruby 3.0'
- name: 'Set up Ruby 3.0'
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.0'

- name: 'Install Asciidoctor'
run: gem install asciidoctor

- name: Vale
- name: 'Run Vale'
uses: errata-ai/vale-action@reviewdog
with:
# Optional
styles: |
https://github.com/errata-ai/Google/releases/latest/download/Google.zip
# Optional
config: https://raw.githubusercontent.com/uyuni-project/uyuni-docs/vale-style-checks-prototype/.vale.ini

files: '["modules/administration", "modules/client-configuration", "modules/common-workflows", "modules/installation-and-upgrade", "modules/quickstart", "modules/reference", "modules/retail", "modules/specialized-guides"]'

env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}


Loading

0 comments on commit b868934

Please sign in to comment.