-
Notifications
You must be signed in to change notification settings - Fork 10
ci: run build, link check, and linters on every PR #41
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
91faeef
style: format plugins and workflows to satisfy the new linters
eddie-knight d07b672
ci: run build, link check, and linters on every PR
eddie-knight b8c5664
style: satisfy yamllint on the catalog data files
eddie-knight 06a8e47
ci: pin actions to commit SHAs and add dependabot
eddie-knight 97e61ae
Apply batched suggestions from @evankanderson
eddie-knight eb35bca
Update .github/workflows/pages.yml
eddie-knight File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # The workflows pin actions to commit SHAs (OpenSSF Scorecard's | ||
| # Pinned-Dependencies check). A pin with no updater is a frozen dependency, | ||
| # so this is what keeps them current: dependabot reads the `# vX.Y.Z` comment | ||
| # beside each SHA to know what it's looking at. | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: github-actions | ||
| directory: "/" | ||
| schedule: | ||
| interval: weekly | ||
| groups: | ||
| actions: | ||
| patterns: ["*"] | ||
|
|
||
| # Gemfile / Gemfile.lock: Jekyll, the plugins, and the lint gems. | ||
| - package-ecosystem: bundler | ||
| directory: "/" | ||
| schedule: | ||
| interval: weekly | ||
| groups: | ||
| gems: | ||
| patterns: ["*"] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| pull_request: | ||
| push: | ||
| branches: ["main"] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| # Newer pushes to a PR supersede in-flight runs | ||
| concurrency: | ||
| group: ci-${{ github.ref }} | ||
| cancel-in-progress: ${{ github.event_name == 'pull_request' }} | ||
|
|
||
| jobs: | ||
| test: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| persist-credentials: false | ||
|
|
||
| - uses: ruby/setup-ruby@e8944e80fb94b20106697132f8c20c665fab29e9 # v1.325.0 | ||
| with: | ||
| ruby-version: "3.3" | ||
| bundler-cache: true | ||
|
|
||
| # Builds the site (catalog_pages.rb fails on duplicate ids and | ||
| # unresolvable persona/problem/relationship targets) then link-checks it. | ||
| - run: make test | ||
|
|
||
| lint: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| persist-credentials: false | ||
|
|
||
| - uses: ruby/setup-ruby@e8944e80fb94b20106697132f8c20c665fab29e9 # v1.325.0 | ||
| with: | ||
| ruby-version: "3.3" | ||
| bundler-cache: true | ||
|
|
||
| - run: pipx install yamllint | ||
|
|
||
| # RuboCop over theme/_plugins, yamllint over data/ and the workflows. | ||
| - run: make lint | ||
|
|
||
| # Workflow syntax and action refs. Not in `make lint` — it's a Go binary, | ||
| # not a gem, and these are the only files it checks. | ||
| - uses: docker://rhysd/actionlint@sha256:b1934ee5f1c509618f2508e6eb47ee0d3520686341fec936f3b79331f9315667 # 1.7.12 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Lints the Jekyll plugins. The layouts and data are covered by `make test`; | ||
| # this is the only hand-written Ruby in the repo. | ||
| AllCops: | ||
| TargetRubyVersion: 3.2 | ||
| NewCops: enable | ||
| Include: | ||
| - "theme/_plugins/**/*.rb" | ||
|
|
||
| # House style, and what every file here already uses. | ||
| Style/StringLiterals: | ||
| EnforcedStyle: double_quotes | ||
|
|
||
| # Each plugin opens with a header comment explaining what it does; a second | ||
| # one directly above the module would just repeat it. | ||
| Style/Documentation: | ||
| Enabled: false | ||
|
|
||
| # catalog_pages.rb's validator is one long linear list of guards. Splitting it | ||
| # to satisfy a length metric would scatter the checks without simplifying them. | ||
| Metrics: | ||
| Enabled: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # Style gate for the hand-edited YAML in data/ and .github/. | ||
| # Semantics are the build's job: theme/_plugins/catalog_pages.rb fails on | ||
| # duplicate ids and unresolvable references. This only keeps the formatting | ||
| # consistent for the project reps who PR against data/working-groups/. | ||
| extends: default | ||
|
|
||
| rules: | ||
| # Record descriptions and notes are prose; wrapping them to 80 would mean | ||
| # reflowing paragraphs on every edit. | ||
| line-length: disable | ||
| # House style: sequences sit at their parent key's column. | ||
| indentation: | ||
| indent-sequences: consistent | ||
| # These are Jekyll data files, not documents on a stream. | ||
| document-start: disable | ||
| truthy: | ||
| # GitHub Actions' `on:` key. | ||
| allowed-values: ["true", "false", "on"] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
3.4 seems also reasonable