Skip to content
This repository was archived by the owner on Jul 1, 2025. It is now read-only.

Commit 7113c96

Browse files
pete-govaj-stein-gsaDimitriZhurkindependabot[bot]kyhu65867
authored
merge all outstanding improvements from develop to main (#171)
* Fix example inventory-item to fix asset-id usage for #1023 (#145) In XML/JSON/YAML serializations, the asset ID for an inventory item is a prop, not a flag. This error in documentation was noticed during final review of #1056. * Add information-type class attribute (#148) * Bump actions/setup-node from 4.1.0 to 4.3.0 (#162) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4.1.0 to 4.3.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@39370e3...cdca736) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update workflow runner from Ubuntu 20.04 to support 22.04 LTS (#167) This update will ensure that GHA jobs do not purposefully fail with brownouts before Ubuntu 20.04 deprecation that is weeks away. Thanks for the reminder, GitHub! * Bump actions/upload-artifact from 4.4.3 to 4.6.2 (#163) Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.4.3 to 4.6.2. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@b4b15b8...ea165f8) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump actions/cache from 4.2.0 to 4.2.3 (#164) Bumps [actions/cache](https://github.com/actions/cache) from 4.2.0 to 4.2.3. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@1bd1e32...5a3ec84) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump lycheeverse/lychee-action from 2.1.0 to 2.4.0 (#166) Bumps [lycheeverse/lychee-action](https://github.com/lycheeverse/lychee-action) from 2.1.0 to 2.4.0. - [Release notes](https://github.com/lycheeverse/lychee-action/releases) - [Commits](lycheeverse/lychee-action@f81112d...1d97d84) --- updated-dependencies: - dependency-name: lycheeverse/lychee-action dependency-version: 2.4.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * add documentation for issue 980 regarding last-accessed (#142) * add documentation for issue 980 regarding last-accessed * Update content/documentation/ssp/5-attachments.md Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update content/documentation/ssp/5-attachments.md Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> --------- Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Add documentation for image-has-checksum (#143) * Bump actions/upload-artifact from 4.4.3 to 4.6.0 Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.4.3 to 4.6.0. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@b4b15b8...65c4c4a) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * Bump lycheeverse/lychee-action from 2.1.0 to 2.2.0 Bumps [lycheeverse/lychee-action](https://github.com/lycheeverse/lychee-action) from 2.1.0 to 2.2.0. - [Release notes](https://github.com/lycheeverse/lychee-action/releases) - [Commits](lycheeverse/lychee-action@f81112d...f796c8b) --- updated-dependencies: - dependency-name: lycheeverse/lychee-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * prelimary restructure * restructuring of file hierarchy * addiginal file-level alignment and adjustments * fine tuning file organization and titles * moved prior content to correct files. Ready to be updated. Refined file organization) * More updated graphics from FR r5 SSP * Update validation overview - issue 1109 * introduce sortable list * add sortable constraint list * add enum visual * add help links and enum values and improve search * sort * Update oscal-fedramp-constraints.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update oscal-fedramp-constraints.md Co-authored-by: A.J. Stein <aj@gsa.gov> * move constraint browser * broke down ssp control content into smaller pieces * broke spp inventory into smaller topic areas * Update oscal-cli.md * Update content/documentation/validation/oscal-cli.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/validation/oscal-cli.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Start Metaschema validation content for GSA/fedramp-automation#1110 * Bump actions/setup-node from 4.1.0 to 4.2.0 Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4.1.0 to 4.2.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@39370e3...1d0ff46) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * improve parameters page * Update services-ports-protocols.md * Trim whitespace :) * Update illustrated architecture and narratives page * Update per review feedback * Update digital-identity.md * Update digital-identity.md * Update digital-identity.md * Update content/documentation/ssp/oscal-representation/digital-identity.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/digital-identity.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/digital-identity.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/digital-identity.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/digital-identity.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Break down required attachments into sub-sections * Make initial updates to index page * Update policies and procedures documentation page * Update User Guide page documentation * Update DIL page * Update Rules of Behavior page * Fix header on RoB page * Update CP attachment page * Update CMP attachment page * Update IRP attachment page * Update ConMon Plan attachment page * Update SCRMP attachment page * Fix grammatical error * Update fips-199-categorization.md * Update content/documentation/ssp/oscal-representation/fips-199-categorization.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/fips-199-categorization.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Added options for json and yaml * Update content/documentation/ssp/oscal-representation/fips-199-categorization.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/fips-199-categorization.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update acronyms-laws-regulations.md * Remove reference to appendix B * add json and yaml support * Update quotations for acronyms-laws-regulations.md * Update content/documentation/ssp/oscal-representation/acronyms-laws-regulations.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/acronyms-laws-regulations.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/acronyms-laws-regulations.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update generated-content.md * Bump lycheeverse/lychee-action from 2.2.0 to 2.3.0 Bumps [lycheeverse/lychee-action](https://github.com/lycheeverse/lychee-action) from 2.2.0 to 2.3.0. - [Release notes](https://github.com/lycheeverse/lychee-action/releases) - [Commits](lycheeverse/lychee-action@f796c8b...f613c4a) --- updated-dependencies: - dependency-name: lycheeverse/lychee-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * Flesh out #1116 content * Some more copy edits for #1116 * Update system owner content example for #1116 * Update OSCAL ISSO example for #1116 * Update AO examples, with and w/o JAB for #1116 * Clean up XML examples, remove distracting XML PI for #1116 * Reorder examples to JSON, YAML, and XML for #1116 * Add 'Leveraged Authorizations' JSON/YAML Examples * Add JSON, XML, and YAML examples in `oscal-identifiers.md` (issue #1137) * Add 'System Information' JSON/YAML' Examples * Add YAML header before merge * Add 'External Systems and Services' JSON/YAML Examples * Add YAML header before merge. * Add 'fedramp-baseline' JSON/YAML Examples * Add YAML header before merge * Revise generated-content.md page (issue #1128) * Add JSON, XML, and YAML examples in `oscal-metadata.md` (issue #1137) * Add JSON, XML, and YAML examples in `oscal-content-overview.md` (issue #1137) * Update cryptographic modules documentation * Updates to cryptographic modules page * Update content/documentation/ssp/oscal-representation/cryptographic-modules.md Co-authored-by: A.J. Stein <alexander.stein@gsa.gov> * Apply suggestions from code review Co-authored-by: A.J. Stein <alexander.stein@gsa.gov> * Reorder JSON/XML/YAML Tabs * add oscal cli docs * Update content/documentation/validation/oscal-cli.md Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@noblis.org> * Update content/documentation/validation/oscal-cli.md Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@noblis.org> * Update content/documentation/validation/oscal-cli.md Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@noblis.org> * Update content/documentation/validation/oscal-cli.md Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@noblis.org> * Update content/documentation/validation/oscal-cli.md Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@noblis.org> * Update content/documentation/validation/metaschema-validation.md Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> * Update oscal-cli.md Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@noblis.org> * move best practices * Minor formatting touch-ups and adding links to upstream docs before merge * Add JSON, YAML, and XML examples in `extensions-and-allowed-values.md` (issue #1137) * Add Xpath Queries * Add spacing in XPath for target baseline version before merge * Add JSON, YAML, and XML examples in `oscal-attachments.md` (issue #1137) * Add 'Security Controls' JSON/YAML Examples * Update content/documentation/ssp/oscal-representation/security-controls/control-definitions.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/security-controls/control-definitions.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Add 'System Inventory' JSON/YAML Examples * Update catalog.md * Update catalog.md * Update catalog.md * Update catalog.md * Update catalog.md * Update catalog.md * Add JSON, YAML, and XML examples in `fedramp-baselines.md` (issue #1137) * add system-security-plan * Add JSON, YAML, and XML examples in `fedramp-version.md` (issue #1138) * Fix `version` with code review changes before merge * Add JSON, XML, and YAML examples in `oscal-data-types.md` (issue #1137) * address comments * Bump actions/cache from 4.2.0 to 4.2.1 Bumps [actions/cache](https://github.com/actions/cache) from 4.2.0 to 4.2.1. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@1bd1e32...0c907a7) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Fix JSON, YAML, and XML examples in `fedramp-version.md` (issue #1138) * Add JSON, YAML, and XML examples in `generated-content.md` (issue #1137) * In JSON, YAML, and XML examples, add "system-security-plan" * Formatting Corrections * Add JSON, YAML, and XML examples in `title-page-information.md` (issue #1138) * address comments * address GSA/fedramp-automation#1047 * document #1047 * provide json and yaml examples * add identification requirements * fix tabs * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * use one liners for xpath expressions * Update identification-requirements.md * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/identification-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/scanning-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/scanning-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/inventory/scanning-requirements.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Finalize editorial changes to "Why matters?" sections from last review * Update identification-requirements.md * Remove the FedRAMP contact information page (issue #1138) * Add JSON, YAML, and XML examples in `document-revision-history` (issue #1138) * Address comments * Bump up oscal-version * Bump actions/upload-artifact from 4.6.0 to 4.6.1 Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.6.0 to 4.6.1. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@65c4c4a...4cec3d8) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Bump actions/cache from 4.2.1 to 4.2.2 Bumps [actions/cache](https://github.com/actions/cache) from 4.2.1 to 4.2.2. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@0c907a7...d4323d4) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Add JSON and YAML examples in `document-approvals.md` (issue #1138) * Update content * Address comments * Fix positioning in navigation pane * Add JSON and YAML examples in `attachments.md` (issue #1138) * Address comments * Address comments * Remove extraneous rel link from party to resource for #1138 * Adjust resource type enums for #1138 for review * Add authorization types documentation * Update content/documentation/ssp/oscal-representation/authorization-paths.md Co-authored-by: A.J. Stein <alexander.stein@gsa.gov> * Add remarks in implementation-status * Update theme submod for GSA/uswds-hugo#267 changes create 508 compliance workflow Update 508-compliance.yml update workflow Update foot.html add accessability css * Update .pa11yci * reduce threshold to 5 * Update GH runner for GHA to not use obsolete runner before merge * Add System Information and Information Types documentation * Bump actions/setup-node from 4.2.0 to 4.3.0 Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4.2.0 to 4.3.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@1d0ff46...cdca736) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * Bump actions/cache from 4.2.0 to 4.2.2 Bumps [actions/cache](https://github.com/actions/cache) from 4.2.0 to 4.2.2. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@v4.2.0...d4323d4) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Bump actions/upload-artifact from 4.6.0 to 4.6.1 Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.6.0 to 4.6.1. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@v4.6.0...4cec3d8) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Fix `impact-level` value in `leveraged-authorizations.md` * Add the `<system-security-plan>` root node * Add SSP redirects (issue #1106) * Add JSON and YAML examples in `prepared-by-for.md` (issue #1138) * Bump actions/upload-artifact from 4.6.1 to 4.6.2 Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.6.1 to 4.6.2. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](actions/upload-artifact@4cec3d8...ea165f8) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Bump actions/cache from 4.2.2 to 4.2.3 Bumps [actions/cache](https://github.com/actions/cache) from 4.2.2 to 4.2.3. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@d4323d4...5a3ec84) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Adjust Control Origination Documentation * Update content/documentation/ssp/oscal-representation/security-controls/control-origination.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/security-controls/control-origination.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Update content/documentation/ssp/oscal-representation/security-controls/control-origination.md Co-authored-by: A.J. Stein <aj@gsa.gov> * Adjust SAP Documentation * Add link redirect template for #1217 * Add example allowed-values redirect example for #1217 * Add example expect constraint redirect example #1217 * Add Markdown files for redirects * Adjust /help/constraints/->/help/constraint/ to align with GSA/fedramp-automation#1220 Align the paths given my feedback in the PR review with comment below. GSA/automate.fedramp.gov_private#75 (review) * Add Markdown files for redirects * Fix URLs * Add missing `external-constraints` URLs * Add missing redirects * Fix FR identifier-type and namespace * Clarify role party association for CSP * Add ODP and aggregate param clarification * fix build error, stabilize * hrm. * tktk --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: A.J. Stein (is on leave now) <aj@gsa.gov> Co-authored-by: DimitriZhurkin <dimitri.zhurkin@noblis.org> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Kylie Hunter <kylie.hunter@gsa.gov> Co-authored-by: Gabeblis <gabriel.rodriguez@gsa.gov> Co-authored-by: brian-ruf <brian.ruf@gmail.com> Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@noblis.org> Co-authored-by: ~ . ~ <156969148+wandmagic@users.noreply.github.com> Co-authored-by: Rene Tshiteya <rene-claude.tshiteya@gsa.gov> Co-authored-by: A.J. Stein <alexander.stein@gsa.gov> Co-authored-by: ~ . ~ <paul.n.wand@gsa.gov> Co-authored-by: U-INNOVATE\M34255 <M34255@1839517E-M34255.innovate.noblis.org>
1 parent 65fb0b4 commit 7113c96

File tree

340 files changed

+19143
-2682
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

340 files changed

+19143
-2682
lines changed
Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
name: 508 Compliance
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- develop
8+
- "release/*"
9+
- "feature/*"
10+
workflow_dispatch:
11+
inputs:
12+
linkcheck_fail_on_error:
13+
description: 'A boolean flag that determines if bad links found by the link checker fail fast'
14+
required: false
15+
default: true
16+
type: boolean
17+
linkcheck_create_issue:
18+
description: 'Create new GitHub issue if broken links are found'
19+
required: false
20+
default: false
21+
type: boolean
22+
23+
env:
24+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
25+
INPUT_FAIL_ON_ERROR: ${{ github.event.inputs.linkcheck_fail_on_error || 'true' }}
26+
INPUT_ISSUE_ON_ERROR: ${{ github.event.inputs.linkcheck_create_issue || 'false' }}
27+
28+
jobs:
29+
build-and-push-website:
30+
name: Build, Push, and 508 Compliance Test
31+
runs-on: ubuntu-22.04
32+
env:
33+
BUILD_PATH: ./build
34+
permissions:
35+
contents: write
36+
steps:
37+
- name: Manage GH_TOKEN
38+
if: env.GH_TOKEN == ''
39+
env:
40+
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
41+
run: echo "GH_TOKEN=${GITHUB_TOKEN}" >> $GITHUB_ENV
42+
43+
- name: Checkout Latest
44+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
45+
with:
46+
submodules: recursive
47+
48+
- name: Setup Swap Space
49+
uses: pierotofy/set-swap-space@49819abfb41bd9b44fb781159c033dba90353a7c
50+
with:
51+
swap-size-gb: 10
52+
53+
- name: Set up NodeJS
54+
uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e
55+
with:
56+
node-version-file: '.nvmrc'
57+
cache: 'npm'
58+
cache-dependency-path: package-lock.json
59+
60+
- name: Setup Dependencies
61+
run: |
62+
# (Optional OSCAL commands omitted for brevity)
63+
npm install --loglevel verbose
64+
echo "$PWD/node_modules/.bin/" >> $GITHUB_PATH
65+
sudo snap install dart-sass
66+
67+
- name: Cache Hugo Modules
68+
uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684
69+
with:
70+
path: /tmp/hugo_cache
71+
key: ${{ runner.os }}-hugomod-${{ hashFiles('**/go.sum') }}
72+
restore-keys: |
73+
${{ runner.os }}-hugomod-
74+
75+
- name: Run Hugo
76+
run: |
77+
hugo -e staging --logLevel debug -d _site-test
78+
79+
- name: Zip Artifacts for Upload
80+
run: |
81+
zip ${{ runner.temp }}/website.zip -r _site-test
82+
83+
- name: Upload Generated Site
84+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
85+
with:
86+
name: website
87+
path: ${{ runner.temp }}/website.zip
88+
retention-days: 5
89+
90+
# === Begin 508 (accessibility) Compliance Testing using pa11y-ci via sitemap ===
91+
92+
- name: Serve site for 508 Compliance Test
93+
run: |
94+
# Serve the built site (_site-test) on port 8080
95+
npx http-server _site-test -p 8080 &
96+
sleep 5
97+
98+
- name: Install pa11y-ci
99+
run: npm install -g pa11y-ci
100+
101+
- name: Run pa11y-ci for 508 Compliance
102+
id: pa11y
103+
run: |
104+
# This command tells pa11y-ci to fetch all URLs from the sitemap,
105+
# excluding any URLs matching "/*.pdf", and use the settings in .pa11yci.
106+
pa11y-ci \
107+
--sitemap http://localhost:8080/sitemap.xml \
108+
--sitemap-find "https://automate.fedramp.gov" \
109+
--sitemap-replace "http://localhost:8080" \
110+
--sitemap-exclude "/*.pdf" \
111+
--config .pa11yci > pa11y_report.md
112+
echo "pa11y_exit_code=$?" >> $GITHUB_ENV
113+
114+
- name: Upload 508 Compliance Report
115+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
116+
with:
117+
name: pa11y-report
118+
path: pa11y_report.md
119+
retention-days: 5
120+
121+
- name: Fail on 508 Compliance Issues
122+
if: ${{ env.pa11y_exit_code != '0' }}
123+
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea
124+
with:
125+
script: |
126+
core.setFailed('508 compliance test failed; please review the pa11y report.')

.github/workflows/workflow-generate-website.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ env:
2525
jobs:
2626
build-and-push-website:
2727
name: Build and Push Website
28-
runs-on: ubuntu-20.04
28+
runs-on: ubuntu-22.04
2929
env:
3030
BUILD_PATH: ./build
3131
permissions:
@@ -47,7 +47,7 @@ jobs:
4747
with:
4848
swap-size-gb: 10
4949
- name: Set up NodeJS
50-
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af
50+
uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e
5151
with:
5252
node-version-file: '.nvmrc'
5353
cache: 'npm'
@@ -62,12 +62,15 @@ jobs:
6262
# - ajv-formats
6363
# - markdown-link-check
6464
# - yaml-convert
65+
npx oscal@latest use latest
66+
npx oscal-cli metaschema convert --to=JSON -m=https://raw.githubusercontent.com/usnistgov/OSCAL/refs/heads/main/src/metaschema/oscal_complete_metaschema.xml https://raw.githubusercontent.com/GSA/fedramp-automation/refs/heads/develop/src/validations/constraints/fedramp-external-constraints.xml ../static/json/fedramp_external_constraints.json --overwrite
67+
npx oscal-cli metaschema convert --to=JSON -m=https://raw.githubusercontent.com/usnistgov/OSCAL/refs/heads/main/src/metaschema/oscal_complete_metaschema.xml https://raw.githubusercontent.com/GSA/fedramp-automation/refs/heads/develop/src/validations/constraints/fedramp-external-allowed-values.xml ../static/json/fedramp_allowed_values.json --overwrite
6568
npm install --loglevel verbose
6669
echo "$PWD/node_modules/.bin/" >> $GITHUB_PATH
6770
# Dart-Sass
6871
sudo snap install dart-sass
6972
# cache hugo modules
70-
- uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57
73+
- uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684
7174
with:
7275
path: /tmp/hugo_cache
7376
key: ${{ runner.os }}-hugomod-${{ hashFiles('**/go.sum') }}
@@ -81,15 +84,15 @@ jobs:
8184
run: |
8285
zip ${{ runner.temp }}/website.zip -r _site-test
8386
- name: Upload generated site
84-
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882
87+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
8588
with:
8689
name: website
8790
path: |
8891
${{ runner.temp }}/website.zip
8992
retention-days: 5
9093
- id: linkchecker
9194
name: Link Checker
92-
uses: lycheeverse/lychee-action@f81112d0d2814ded911bd23e3beaa9dda9093915
95+
uses: lycheeverse/lychee-action@f613c4a64e50d792e0b31ec34bbcbba12263c6a6
9396
with:
9497
args: --exclude-file .github/workflows/config/.lycheeignore --verbose --no-progress --accept 200,206,429 './_site-test/**/*.html' --remap "https://automate.fedramp.gov/ file://${GITHUB_WORKSPACE}/_site-test/" --exclude-mail
9598
format: markdown
@@ -100,7 +103,7 @@ jobs:
100103
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
101104
continue-on-error: true
102105
- name: Upload link check report
103-
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882
106+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
104107
with:
105108
name: html-link-report
106109
path: html-link-report.md

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,7 @@
22
/.hugo_build.lock
33
/hugo_stats.json
44

5-
/node_modules
5+
/node_modules
6+
.vscode
7+
.DS_Store
8+
pa11y_report.md

.pa11yci

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"defaults": {
3+
"standard": "WCAG2AA",
4+
"runners": ["axe"],
5+
"concurrency": 1,
6+
"threshold": 5
7+
8+
},
9+
"urls": [
10+
"http://localhost:8080"
11+
]
12+
}

.tool-versions

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
hugo 0.124.1

config/_default/hugo.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ params:
4141
sidenav:
4242
custom_css:
4343
- css/site.css
44+
- css/accessibility.css
4445
searchAffiliate: fedramp-automation
4546
# debug: true
4647
markup:

content/collaborate/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ cascade:
1616

1717
You can collaborate with FedRAMP and its automation initiatives in multiple ways.
1818

19-
- You can participate in [pilots](https://www.fedramp.gov/fedramp-pilots/), like the [Digital Authorization Pilot](https://www.fedramp.gov/digital-authorization-package-pilot/). You will use the FedRAMP Automation Team's tools, data, and documentation, evaluate them, and provide feedback.
19+
- You can participate in [pilots](https://www.fedramp.gov/updates/pilots/), like the [Digital Authorization Pilot](https://www.fedramp.gov/updates/pilots/digital-authorization-package/). You will use the FedRAMP Automation Team's tools, data, and documentation, evaluate them, and provide feedback.
2020
- You can attend FedRAMP Automation Team [meetings](./meetings/). You can provide feedback or directly propose changes.
2121
- You can provide feedback or propose changes via GitHub or email. See [the contact page](../contact/) for more information.

content/documentation/_index.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,23 @@ It provides guidance and examples intended to guide an organization in the produ
2424

2525
XML and JSON use different terminology. Instead of repeatedly clarifying format-specific terminology, this document uses the following format-agnostic terminology through the document.
2626

27-
|**TERM**|**XML EQUIVALENT**|**JSON EQUIVALENT**|
28-
| :- | :- | :- |
29-
|**Field**|A single element or text value that can hold a value or an attribute|A single object that can hold a value or property|
30-
|**Flag**|Attribute|Property|
31-
|**Assembly**|A collection of elements. Typically, a parent node with one or more child nodes.|A collection of objects. Typically, a parent object with one or more child objects.|
27+
|**OSCAL<br />TERM**|**XML EQUIVALENT**|**JSON EQUIVALENT**|
28+
| :-: | :- | :- |
29+
|**Field**|An atomic xml element that can contain a value.<br/>An OSCAL field may have OSCAL Flags (XML attributes) associated with it. | An atomic JSON object that can contain a value.<br /> An OSCAL field may have OSCAL Flags (atomic JSON child objects) associated with it. |
30+
|**Flag**| An XML Attribute | An atomic JSON child object |
31+
|**Assembly**|A collection of related XML elements under a parent element.|A collection of related JSON objects under a parent object.|
3232

33-
These terms are used by the National Institute of Standards and Technology (NIST) in the creation of OSCAL syntax.
33+
These terms are used by the National Institute of Standards and Technology (NIST) in the definition of OSCAL syntax.
3434

3535
Throughout this document, the following words are used to differentiate between requirements, recommendations, and options.
3636

3737
|**TERM**|**MEANING**|
3838
| :- | :- |
39-
|**must**|Indicates a required action.|
40-
|**should**|Indicates an action that is very important and strongly recommended, but is not required.|
41-
|**may**|Indicates an optional action.|
39+
|**MUST**|Indicates a required action.|
40+
|**MUST NOT**|Indicates a prohibited action.|
41+
|**SHOULD**|Indicates an action that is very important and strongly recommended, but is not required.|
42+
|**SHOULD NOT**|Indicates an action that carries risks, and avoidance is strongly recommended; however, the action is not strictly prohibited.|
43+
|**MAY**|Indicates an optional action.|
4244

4345

4446
## XML, JSON and YAML Formats

content/documentation/changes.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Significant Changes
3+
weight: 100
4+
menu:
5+
primary:
6+
name: Significant Changes
7+
parent: Documentation
8+
weight: 50
9+
---
10+
# Significant Changes
11+
12+
FedRAMP Designation
13+
14+
- FedRAMP namespace designation change for `part` and `prop`
15+
- from `https://fedramp.gov/ns/oscal` to `http://fedramp.gov/ns/oscal` (dropping the `s` in `https`)
16+
- FedRAMP system identifier change
17+
- from `???` to `http://fedramp.gov/ns/oscal` (dropping the `s` in `https`)
18+
- others?
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Common FedRAMP Content
3+
weight: 300
4+
suppresstopiclist: false
5+
menu:
6+
primary:
7+
name: Common FedRAMP Content
8+
parent: Documentation
9+
weight: 300
10+
---
11+
# Common FedRAMP Content
12+
13+
While each FedRAMP template has a unique purpose, they share common
14+
information elements, such as title and publication date. These common
15+
elements are expressed using the same OSCAL syntax for the SSP, SAP,
16+
SAR, and POA&M. This section provides OSCAL syntax for these common
17+
elements.

0 commit comments

Comments
 (0)