Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: udpate docs #47

Merged
merged 2 commits into from
Aug 28, 2024
Merged
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
17 changes: 17 additions & 0 deletions .github/workflows/commitlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,20 @@
env:
pull_request_title: ${{ github.event.pull_request.title }}
run: echo "$pull_request_title" | npx commitlint

lint-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
- name: Use Node.js latest
uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
with:
node-version: 20
- name: Set up Homebrew
uses: Homebrew/actions/setup-homebrew@master
- name: Install UDS CLI
shell: bash
# renovate: datasource=github-tags depName=defenseunicorns/uds-cli versioning=semver
run: brew install defenseunicorns/tap/[email protected]
- name: Run Formatting Checks
run: uds run lint-check --no-progress

Check failure on line 50 in .github/workflows/commitlint.yaml

View workflow job for this annotation

GitHub Actions / lint-check

50:46 [new-line-at-end-of-file] no new line character at the end of file
75 changes: 12 additions & 63 deletions .github/workflows/docs-shim.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,67 +19,16 @@
- LICENSE

jobs:
check-only-docs-changes:
runs-on: ubuntu-latest
outputs:
docs_only: ${{ steps.set_output.outputs.docs_only }}
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Check for non-docs changes
id: docs_check
uses: ./.github/actions/docs-only
with:
base_ref: ${{ github.base_ref }}

- name: Set outputs
id: set_output
run: echo "docs_only=${{ steps.docs_check.outputs.docs_only }}" >> $GITHUB_OUTPUT

lint-check:
needs: check-only-docs-changes
if: ${{ needs.check-only-docs-changes.outputs.docs_only == 'true' }}
name: Lint Check(Simulated)
runs-on: ubuntu-latest
steps:
- name: Lint Check
run: echo "Simulating lint-check job - Success!"

check-paths:
needs: check-only-docs-changes
if: ${{ needs.check-only-docs-changes.outputs.docs_only == 'true' }}
name: Check Paths(Simulated)
runs-on: ubuntu-latest
steps:
- name: Check Paths
run: echo "Simulating check-paths job - Success!"

run-package-test:
needs: check-only-docs-changes
if: ${{ needs.check-only-docs-changes.outputs.docs_only == 'true' }}
name: Package Test(Simulated)
runs-on: ubuntu-latest
steps:
- name: Run Package Test
run: echo "Simulating run-package-test job - Success!"

evaluate-package-compliance:
needs: check-only-docs-changes
if: ${{ needs.check-only-docs-changes.outputs.docs_only == 'true' }}
name: Compliance Test(Simulated)
runs-on: ubuntu-latest
steps:
- name: Evaluate Package Compliance
run: echo "Simulating evaluate-package-compliance job - Success!"

# slim-dev-test.yaml
test:
needs: check-only-docs-changes
if: ${{ needs.check-only-docs-changes.outputs.docs_only == 'true' }}
name: Slim Dev Test(Simulated)
runs-on: ubuntu-latest
steps:
- name: Shim for Slim Dev Test
run: |
echo "Documentation-only change detected; marking test successful."
name: Schedule
strategy:
matrix:
package: [all]
flavor: [upstream, registry1, unicorn]
test_type: [install,upgrade]

Check failure on line 28 in .github/workflows/docs-shim.yaml

View workflow job for this annotation

GitHub Actions / lint-check

28:29 [commas] too few spaces after comma
uses: ./.github/workflows/test-shim.yaml
with:
package: ${{ matrix.package }}
flavor: ${{ matrix.flavor }}
test_type: ${{ matrix.test_type }}
secrets: inherit # Inherits all secrets from the parent workflow.

Check failure on line 34 in .github/workflows/docs-shim.yaml

View workflow job for this annotation

GitHub Actions / lint-check

34:70 [new-line-at-end-of-file] no new line character at the end of file
36 changes: 0 additions & 36 deletions .github/workflows/pull-request-conditionals.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,26 +38,8 @@ concurrency:
cancel-in-progress: true

jobs:
lint-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
- name: Use Node.js latest
uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
with:
node-version: 20
- name: Set up Homebrew
uses: Homebrew/actions/setup-homebrew@master
- name: Install UDS CLI
shell: bash
# renovate: datasource=github-tags depName=defenseunicorns/uds-cli versioning=semver
run: brew install defenseunicorns/tap/[email protected]
- name: Run Formatting Checks
run: uds run lint-check --no-progress

# This job checks if there are changes in specific paths source packages.
check-paths:
needs: lint-check
runs-on: ubuntu-latest
name: Select Jobs
outputs:
Expand All @@ -75,24 +57,6 @@ jobs:
filters: .github/filters.yaml
predicate-quantifier: every

# check-only-docs-changes:
# runs-on: ubuntu-latest
# outputs:
# docs_only: ${{ steps.set_output.outputs.docs_only }}
# steps:
# - name: Checkout code
# uses: actions/checkout@v3

# - name: Check for non-docs changes
# id: docs_check
# uses: ./.github/actions/docs-only
# with:
# base_ref: ${{ github.base_ref }}

# - name: Set outputs
# id: set_output
# run: echo "docs_only=${{ steps.docs_check.outputs.docs_only }}" >> $GITHUB_OUTPUT

# This job triggers a separate workflow for each changed source package, if any.
run-package-test:
needs: check-paths
Expand Down
42 changes: 42 additions & 0 deletions .github/workflows/test-shim.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Test Shim

on:
# Manual trigger
workflow_dispatch:
inputs:
package:
type: string
description: "The name of the source package to test"
required: true
flavor:
type: string
description: "Flavor of the source package to test"
required: true
test_type:
type: string
description: "The type of test to perform"
required: true
# Triggered by pull-request-conditionals.yaml
workflow_call:
inputs:
package:
type: string
description: "The name of the source package to test"
required: true
flavor:
type: string
description: "Flavor of the source package to test"
required: true
test_type:
type: string
description: "The type of test to perform"
required: true

jobs:
test:
runs-on: 'ubuntu-latest'
name: Test
steps:
- name: Skipped
run: |
echo skipped

Check failure on line 42 in .github/workflows/test-shim.yaml

View workflow job for this annotation

GitHub Actions / lint-check

42:23 [new-line-at-end-of-file] no new line character at the end of file
2 changes: 2 additions & 0 deletions src/keycloak/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## Keycloak

testing

[Keycloak](https://www.keycloak.org/) is an open source IdAM stack written in Java. This Keycloak source package provides an implementation of Keycloak and is intended to be used in conjunction with the [UDS Identity Config](https://github.com/defenseunicorns/uds-identity-config) image and the [UDS Operator](../pepr/operator/README.md).

### Changes from the DoD Platform One Big Bang package
Expand Down
Loading