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

Switch Generated Website Content Link Checking to lychee from untitaker/hyperlink #1208

Closed
4 tasks
aj-stein-nist opened this issue Apr 18, 2022 · 2 comments · Fixed by #1231
Closed
4 tasks
Assignees
Labels
Developer Experience Issues around enhancing and optimizing work for development of NIST OSCAL artifacts enhancement Scope: CI/CD Enhancements to the project's Continuous Integration and Continuous Delivery pipeline. User Story
Milestone

Comments

@aj-stein-nist
Copy link
Contributor

aj-stein-nist commented Apr 18, 2022

User Story:

As a NIST OSCAL developer, in order to ensure all links in the generated website content point to valid hyperlink targets in a faster and more efficient way with minimal configuration, I would to implement an alternative approach to link checking the generated content as part of CI workflows in GitHub Actions.

This closes #1201.

Goals:

When reviewing current work with Dave for the sprint, we reviewed #1201. The nokogiri dependency is needed for HTML proofer, which is tech debt from a previous iteration of proper link checking needed for generated HTML and was replaced in the interim by the Javascript-based untitaker/hyperlink in a published GitHub action. See 9a6eb48 for the current approach.

Goals of the replacement:

  • Available in a stable, well-maintained GitHub Action
  • As performant and fast as possible
  • As little configuration out of the box needed as possible
    • Ability to exclude resources in an easy, configurable way
  • Reliable reporting in a usable format

After using usnistgov/metaschema#204 as a quick in the moment spike, Dave and I agreed lychee and its officially published GH Action better fit the bill.

Dependencies:

Final completion and review of usnistgov/metaschema#204 once merged for final integration testing.

Acceptance Criteria

  • Necessary GH Action workflow specifications and modified and reviewed by one or more team members.
  • All OSCAL website 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.

{The items above are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.}

@aj-stein-nist aj-stein-nist self-assigned this Apr 18, 2022
@aj-stein-nist aj-stein-nist added this to the OSCAL 1.0.3 milestone Apr 18, 2022
@aj-stein-nist aj-stein-nist added Scope: CI/CD Enhancements to the project's Continuous Integration and Continuous Delivery pipeline. Developer Experience Issues around enhancing and optimizing work for development of NIST OSCAL artifacts labels Apr 18, 2022
@aj-stein-nist
Copy link
Contributor Author

I am going to move this from 1.0.3 ti 1.1.0 release for now @david-waltermire-nist, as I am out of office for the targeted completion of the sprint. Feel free to assign it to others and bring it back in, or I will pick it up when I am back.

@aj-stein-nist
Copy link
Contributor Author

Alright, I am going to pick this up now after convo today during issue triage re #737.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Developer Experience Issues around enhancing and optimizing work for development of NIST OSCAL artifacts enhancement Scope: CI/CD Enhancements to the project's Continuous Integration and Continuous Delivery pipeline. User Story
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants