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.

Sign up for GitHub

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

Move web content from OSCAL, and other streamlining. #1824

Closed
wants to merge 9 commits into from
Closed

Move web content from OSCAL, and other streamlining. #1824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
fc22bd7
Adjustment of OSCAL project to support multi-repository approach
Compton-US Jun 26, 2023
2e3e889
Adjustment of OSCAL project to support multi-repository approach
Compton-US Jun 26, 2023
82181bd
Revising commits based on rebase to develop.
Jul 12, 2023
a224501
Remove example file.
Jul 12, 2023
339f1fc
Cleanup based on pipeline updates.
Jul 12, 2023
f4aa6ae
Publishing generated metaschema resources [ci skip]
oscalbuilder Jul 12, 2023
960f972
Update metaschema.
Jul 12, 2023
318bd17
Publishing generated metaschema resources [ci skip]
oscalbuilder Jul 12, 2023
bfdc2bf
Stop auto-commit in main CI/CD
Jul 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
62 changes: 0 additions & 62 deletions .github/workflows/link-check.yml
View file
Open in desktop

This file was deleted.

40 changes: 7 additions & 33 deletions .github/workflows/status-ci-cd.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,36 +21,10 @@ jobs:
uses: ./.github/workflows/workflow-generate-metaschema-resources.yml
with:
commit_resources: false
push-metaschema-artifacts:
if: github.event_name == 'push'
uses: ./.github/workflows/workflow-generate-metaschema-resources.yml
with:
commit_resources: true
secrets:
access_token: ${{ secrets.COMMIT_TOKEN }}
validate-website-reference:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question, unclear if it is blocking: we need to determine how we will generate schemas in these pipelines even if they are not committed inline anymore, and that means adapting metaschema-xslt, in this PR branch or another.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this has been addressed or not, or if it is still a potential issue -- @nikitawootten-nist ?

Copy link
Contributor

@nikitawootten-nist nikitawootten-nist Jul 10, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we are planning on removing auto-comitting actions as stated in the ADR, we should probably do the following:

  1. Streamline the schema and converter generation to be as simple to invoke as possible (another makefile?)
  2. Modify the existing action to build the schemas and converters without committing for PRs
  3. Also make the action upload schema artifacts on release

For existing releases we'll have to manually upload the correct artifacts (which is simple but a bit tedious, thankfully we only have a few releases so it shouldn't be too painful)

Should we align the ADR draft to support this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This work has been summarized in a follow-on issue: #1847

if: github.event_name == 'pull_request'
uses: ./.github/workflows/workflow-generate-website-reference.yml
with:
commit_resources: false
push-website-reference:
if: github.event_name == 'push'
uses: ./.github/workflows/workflow-generate-website-reference.yml
with:
commit_resources: true
secrets:
access_token: ${{ secrets.COMMIT_TOKEN }}
validate-website:
if: github.event_name == 'pull_request'
needs: validate-website-reference
uses: ./.github/workflows/workflow-generate-website.yml
with:
commit_resources: false
push-website:
if: github.event_name == 'push'
needs: push-website-reference
uses: ./.github/workflows/workflow-generate-website.yml
with:
commit_resources: true
secrets:
access_token: ${{ secrets.COMMIT_TOKEN }}
# push-metaschema-artifacts:
# if: github.event_name == 'push'
# uses: ./.github/workflows/workflow-generate-metaschema-resources.yml
# with:
# commit_resources: true
# secrets:
# access_token: ${{ secrets.COMMIT_TOKEN }}
16 changes: 16 additions & 0 deletions .github/workflows/workflow-generate-metaschema-resources.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,3 +151,19 @@ jobs:
commit_user_email: oscal@nist.gov
commit_author: OSCAL GitHub Actions Bot <oscal@nist.gov>
commit_message: Publishing generated metaschema resources [ci skip]
# Turning this off since the plan would be to publish the schemas and convertors, but not store in the project source.
# # Store Built Artifacts
# # ---------------
# - name: Publish Schemas and Converters
# # only do this on master
# if: github.event.inputs.commit_resources == 'true' || inputs.commit_resources == true
# uses: stefanzweifel/git-auto-commit-action@be7095c202abcf573b09f20541e0ee2f6a3a9d9b
# with:
# repository: ${{ env.CHECKOUT_PATH }}
# file_pattern: xml json
# skip_dirty_check: false
# commit_user_name: OSCAL GitHub Actions Bot
# commit_user_email: oscal@nist.gov
# commit_author: OSCAL GitHub Actions Bot <oscal@nist.gov>
# commit_message: Publishing generated metaschema resources [ci skip]

170 changes: 0 additions & 170 deletions .github/workflows/workflow-generate-website-reference.yml
View file
Open in desktop

This file was deleted.

Loading