Skip to content

Commit

Permalink
Merge branch 'usnistgov:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Rene2mt authored Jan 27, 2023
2 parents e1745e2 + 2e1688b commit 0f55e5b
Show file tree
Hide file tree
Showing 355 changed files with 626,367 additions and 356,424 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
/xml/
/src/ @usnistgov/itl-oscal-maintainers
/src/metaschema @david-waltermire-nist
/src/specifications/profile-resolution @stephenbanghart
/src/specifications/profile-resolution @david-waltermire-nist @wendellpiez
/src/utils @wendellpiez
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

This directory contains templates for creating new OSCAL issues in GitHub. The structure and contents of the directory are as follows:

* [bug_report.md](bug_report.md): This file contains a template for creating a new issue in GitHub to report a bug.
* [question.md](question.md): This file contains a template for creating a new issue in GitHub containing a general question about the project.
* [feature_request.md](feature_request.md): This file contains a template for creating a new issue in GitHub containing a user story.
- [bug_report.md](bug_report.yaml): This file contains a template for creating a new issue in GitHub to report a bug.
- [question.md](question.yaml): This file contains a template for creating a new issue in GitHub containing a general question about the project.
- [feature_request.md](feature_request.yaml): This file contains a template for creating a new issue in GitHub containing a user story.
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Bug report
description: Create a report to help us improve
labels: ['bug']
body:
# - type: checkboxes
# attributes:
# label: Is there an existing issue for this?
# description: Please search to see if an issue already exists for the bug you encountered.
# options:
# - label: I have searched the existing issues
# required: true
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is
validations:
required: true
- type: textarea
id: bug-affecting-who
attributes:
label: Who is the bug affecting
description: Describe the stakeholders affected by this bug
validations:
required: true
- type: dropdown
id: bug-affecting-what
attributes:
label: What is affected by this bug
description: Select the area(s) describing the scope of this bug
options:
- CI/CD
- OSCAL Content
- Documentation
- Metaschema
- Modeling
- Tooling & API
- Website
multiple: true
validations:
required: true
# - type: textarea
# id: bug-conditions
# attributes:
# label: When does this occur
# description: Describe the conditions under which the bug is occuring
# validations:
# required: true
- type: textarea
id: bug-replication
attributes:
label: How do we replicate this issue
description: What are the steps to reproduce this behavior (use screenshots if applicable)
placeholder: |
1. Do this...
2. Then this...
3. See error...
validations:
required: true
- type: textarea
id: bug-solution
attributes:
label: Expected behavior (i.e. solution)
description: A clear and concise description of what you expected to happen
validations:
required: true
- type: textarea
id: bug-comments
attributes:
label: Other comments
description: Add any other context about the problem here
validations:
required: false
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature Request
description: Suggest an idea for this project
labels: ['User Story', 'enhancement']
body:
- type: textarea
id: story
attributes:
label: User Story
description: Describe the feature from the user's perspective, e.g. "As a an OSCAL ..., I need to be able to..."
placeholder: |
As an OSCAL {stakeholder}, I {provide a clear and concise description of what the problem is. Ex. I need to be able to ...}
validations:
required: true
- type: textarea
id: goals
attributes:
label: Goals
description: Describe what you want to happen. This should be outcome focused. Include descriptions of any alternative solutions or features you've considered. Feel free to include any screenshots or examples.
validations:
required: true
- type: textarea
id: dependencies
attributes:
label: Dependencies
description: Describe any previous issues or related work that must be completed to start or complete this issue.
- type: textarea
id: acceptance_criteria
attributes:
label: Acceptance Criteria
description: The items below are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.
value: |
- [ ] All [OSCAL website](https://pages.nist.gov/OSCAL) and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
- [ ] A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
- [ ] The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
validations:
required: true

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Question
description: Ask your question
labels: ['question']
body:
- type: markdown
attributes:
value: Please note, the OSCAL [Q&A discussion board](https://github.com/usnistgov/OSCAL/discussions/categories/q-a) is a more appropriate place for asking most questions.
- type: textarea
id: question-text
attributes:
label: Question
description: Please enter your question
validations:
required: true
4 changes: 3 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@

### All Submissions:

- [ ] Have you selected the correct base branch per [Contributing](https://github.com/usnistgov/OSCAL/blob/master/CONTRIBUTING.md) guidance?
- [ ] Have you selected the correct base branch per [Contributing](https://github.com/usnistgov/OSCAL/blob/main/CONTRIBUTING.md) guidance?
- [ ] Have you set "[Allow edits and access to secrets by maintainers
](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)"?
- [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/usnistgov/OSCAL/pulls) for the same update/change?
- [ ] Have you squashed any non-relevant commits and commit messages? \[[instructions](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)\]
- [ ] Do all automated CI/CD checks pass?

By submitting a pull request, you are agreeing to provide this contribution under the [CC0 1.0 Universal public domain](https://creativecommons.org/publicdomain/zero/1.0/) dedication.

### Changes to Core Features:

- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
Expand Down
45 changes: 45 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@

version: 2
updates:

- package-ecosystem: "gitsubmodule"
directory: "/"
schedule:
interval: "daily"
target-branch: "develop"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
target-branch: "develop"

- package-ecosystem: "docker"
directory: "/build"
schedule:
interval: "daily"
target-branch: "develop"

- package-ecosystem: "gomod"
directory: "/build"
schedule:
interval: "daily"
target-branch: "develop"

- package-ecosystem: "maven"
directory: "/build"
schedule:
interval: "daily"
target-branch: "develop"

- package-ecosystem: "npm"
directory: "/build"
schedule:
interval: "daily"
target-branch: "develop"

- package-ecosystem: "pip"
directory: "/build/python"
schedule:
interval: "daily"
target-branch: "develop"
21 changes: 18 additions & 3 deletions .github/workflows/issue-triage.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,27 @@
name: Triage Board Management

on:
issues:
types: [opened]
types:
- opened
- closed
jobs:
createCard:
runs-on: ubuntu-latest
runs-on: ubuntu-20.04
if: github.event.action == 'opened'
steps:
- name: Add New Issues to Issue Triage Board
uses: peter-evans/create-or-update-project-card@866533e2ae61f13c35fd1d374049713fab43c729 # current tag: v2
uses: peter-evans/create-or-update-project-card@866533e2ae61f13c35fd1d374049713fab43c729
with:
project-name: Issue Triage
column-name: Needs Triage
removeCard:
runs-on: ubuntu-20.04
if: github.event.action == 'closed'
steps:
- uses: alex-page/github-project-automation-plus@bb266ff4dde9242060e2d5418e120a133586d488
with:
project: Issue Triage
column: Done
action: delete
repo-token: ${{ secrets.COMMIT_TOKEN }}
62 changes: 62 additions & 0 deletions .github/workflows/link-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Link Check

on:
schedule:
- cron: "00 8 * * *" # 0800 UTC is 0400 AM EDT
repository_dispatch:
workflow_dispatch:
inputs:
ignorePattern:
description: 'a pattern provided to grep for files/directories to ignore'
required: false
default: '^docs/'
type: string
markdownLinkCheckConfig:
description: 'the path to the markdown link check config file'
required: false
default: 'build/config/.markdown-link-check/config.json'
type: string
site_git_ref:
description: 'git ref, a SHA commit or branch or tag, for the published HTML content'
required: true
default: 'nist-pages'
type: string
site_git_ref_path:
description: 'the subdirectory to check out git ref and check links in website content'
required: true
default: 'published'
type: string
create_issue:
description: 'create new GitHub issue if broken links found'
required: false
default: true
type: boolean
jobs:
schedule-validate-repo-markdown-links:
uses: ./.github/workflows/workflow-validate-repo-markdown.yml
if: github.event_name != 'workflow_dispatch'
with:
ignorePattern: '^docs/'
markdownLinkCheckConfig: 'build/config/.markdown-link-check/config.json'
create_issue: true
schedule-validate-repo-markdown-links-debug:
uses: ./.github/workflows/workflow-validate-repo-markdown.yml
if: github.event_name == 'workflow_dispatch'
with:
ignorePattern: ${{ github.event.inputs.ignorePattern }}
markdownLinkCheckConfig: ${{ github.event.inputs.markdownLinkCheckConfig }}
create_issue: ${{ contains('true', github.event.inputs.create_issue) }}
schedule-validate-website-links:
uses: ./.github/workflows/workflow-validate-website-content.yml
if: github.event_name != 'workflow_dispatch'
with:
site_git_ref: 'nist-pages'
site_git_ref_path: 'published'
create_issue: true
schedule-validate-website-links-debug:
uses: ./.github/workflows/workflow-validate-website-content.yml
if: github.event_name == 'workflow_dispatch'
with:
site_git_ref: ${{ github.event.inputs.site_git_ref }}
site_git_ref_path: ${{ github.event.inputs.site_git_ref_path }}
create_issue: ${{ contains('true', github.event.inputs.create_issue) }}
Loading

0 comments on commit 0f55e5b

Please sign in to comment.