Skip to content

Commit b480afb

Browse files
mhuckamhucka
committed
chore: merge branch
2 parents c031774 + 687cad1 commit b480afb

25 files changed

+533
-220
lines changed

‎.gitattributes

Lines changed: 71 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,75 @@
1-
# -*- mode: sh; -*-
1+
# Summary: repository-specific file attributes assignments for git.
2+
#
3+
# Copyright 2024 California Institute of Technology.
4+
# License: Modified BSD 3-clause – see file "LICENSE" in the project website.
5+
# Website: https://github.com/caltechlibrary/boffo
26

3-
# Set the default behavior, in case people don't have core.autocrlf set.
4-
# .............................................................................
7+
# Set default interpretation of line endings ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58

69
* text=auto
710

8-
# Specify what's text and should be normalized.
9-
# .............................................................................
10-
11-
*.py text
12-
*.in text
13-
*.rst text
14-
*.cfg text
15-
*.ini text
16-
*.yml text
17-
*.json text
18-
*.bat text
19-
*.sh text
20-
LICENSE text
21-
CONTRIBUTING text
22-
23-
# Denote all files that are truly binary and should not be modified.
24-
# .............................................................................
25-
26-
*.png binary
27-
*.jpg binary
28-
*.xls binary
29-
*.doc binary
30-
31-
# This next one is because in other projects, we've had problems with git
32-
# getting confused about line endings when people using Windows and Mac edit
33-
# the same files.
34-
# .............................................................................
35-
36-
*.csv binary diff=csv
11+
# Interpretation of common text files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12+
13+
*.bat text eol=crlf
14+
*.cff text
15+
*.cfg text
16+
*.css text diff=css
17+
*.env text
18+
*.html text diff=html
19+
*.ini text
20+
*.ipynb text eol=lf
21+
*.js text
22+
*.json text
23+
*.md text diff=markdown
24+
*.py text diff=python
25+
*.rst text
26+
*.sh text
27+
*.sql text
28+
*.svg text
29+
*.toml text
30+
*.tex text diff=tex
31+
*.txt text
32+
*.xml text diff=xml
33+
*.yaml text merge=yaml
34+
*.yml text merge=yaml
35+
36+
# RC files like .babelrc, .eslintrc, etc.
37+
*.*rc text
38+
39+
# This avoids compatibility issues between Windows and Mac.
40+
*.csv text eol=crlf
41+
42+
LICENSE text
43+
Makefile text
44+
45+
*.*ignore text
46+
*.gitattributes text
47+
.gitconfig text
48+
49+
# Interpretation of common binary files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50+
51+
*.bz binary
52+
*.DOC binary
53+
*.doc binary
54+
*.DOCX binary
55+
*.docx binary
56+
*.DOT binary
57+
*.dot binary
58+
*.gz binary
59+
*.jpeg binary
60+
*.jpg binary
61+
*.PDF binary
62+
*.pdf binary
63+
*.RTF binary
64+
*.rtf binary
65+
*.tar binary
66+
*.tgz binary
67+
*.tif binary
68+
*.tiff binary
69+
*.xls binary
70+
*.zip binary
71+
72+
# Interpretation of Mac-specific files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73+
74+
*.quartz text diff=xml
75+
*.shortcut binary

‎.github/SECURITY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Reporting security issues
2+
3+
Please report security issues using the [issue tracker](https://github.com/caltechlibrary/boffo/issues) for this repository.

‎.github/workflows/bad-link-reporter.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# ╭─────────────────── Notice ── Notice ── Notice ───────────────────╮
2+
# │ This is a custom Baler workflow file. It is different from the │
3+
# │ sample workflow suggested for users because it is designed to │
4+
# │ allow testing Baler. DO NOT COPY THIS FILE; instead, use the │
5+
# │ sample workflow file named "sample-workflow.yml" from the Baler │
6+
# │ source repository at https://github.com/caltechlibrary/baler/. │
7+
# ╰─────────────────── Notice ── Notice ── Notice ───────────────────╯
8+
9+
name: Bad Link Reporter
10+
11+
# Configure this section ─────────────────────────────────────────────
12+
13+
env:
14+
# Files examined by the workflow:
15+
files: '*.md'
16+
17+
# Label assigned to issues created by this workflow:
18+
labels: bug
19+
20+
# Number of previous issues to check for duplicate reports.
21+
lookback: 10
22+
23+
# Time (sec) to wait on an unresponsive URL before trying once more.
24+
timeout: 15
25+
26+
# Optional file containing a list of URLs to ignore, one per line:
27+
ignore: .github/workflows/ignored-urls.txt
28+
29+
on:
30+
schedule: # Cron syntax is: "min hr day-of-month month day-of-week"
31+
- cron: 00 04 * * 1
32+
push:
33+
paths:
34+
- .github/workflows/bad-link-reporter.yml
35+
- .github/workflows/ignored-urls.txt
36+
workflow_dispatch:
37+
inputs:
38+
files:
39+
description: Comma-separated paths or regexp's
40+
default: '*.md'
41+
labels:
42+
description: Comma-separated issue labels
43+
default: bug
44+
ignore:
45+
description: File containing URLs to ignore
46+
default: .github/workflows/ignored-urls.txt
47+
lookback:
48+
description: No. of previous issues to check
49+
default: 10
50+
debug:
51+
description: Run in debug mode
52+
type: boolean
53+
54+
# The rest of this file should be left as-is ─────────────────────────
55+
56+
run-name: Test links in Markdown files
57+
jobs:
58+
Baler:
59+
name: Link checker and reporter
60+
runs-on: ubuntu-latest
61+
permissions:
62+
issues: write
63+
steps:
64+
- uses: caltechlibrary/baler@main
65+
with:
66+
files: ${{github.event.inputs.files || env.files}}
67+
labels: ${{github.event.inputs.labels || env.labels}}
68+
ignore: ${{github.event.inputs.ignore || env.ignore}}
69+
timeout: ${{github.event.inputs.timeout || env.timeout}}
70+
lookback: ${{github.event.inputs.lookback || env.lookback}}

‎.github/workflows/build-docs.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ run-name: Build gh-pages for ${{inputs.release_tag || 'latest release'}}
1414

1515
on:
1616
push:
17-
branches: ['main']
18-
paths: ['docs/**']
17+
branches:
18+
- main
19+
paths:
20+
- docs/**
1921

2022
jobs:
2123
deploy:

‎.github/workflows/iga.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ on:
4646

4747
jobs:
4848
run_iga:
49-
name: "Send to ${{needs.get_repository.outputs.server}}"
49+
name: Send to ${{needs.get_repository.outputs.server}}
5050
runs-on: ubuntu-latest
5151
needs: get_repository
5252
steps:
@@ -62,7 +62,7 @@ jobs:
6262
parent_record: ${{github.event.inputs.parent_record || env.parent_record}}
6363
release_tag: ${{github.event.inputs.release_tag || 'latest'}}
6464
get_repository:
65-
name: "Get repository name"
65+
name: Get repository name
6666
runs-on: ubuntu-latest
6767
outputs:
6868
server: ${{steps.parse.outputs.host}}

‎.github/workflows/ignored-urls.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
https://workspace.google.com/marketplace/app/boffo/830370816631

‎.github/workflows/markdown-linter.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Summary: GitHub Actions workflow to run a Markdown linter on .md files.
2+
#
3+
# Copyright 2024 California Institute of Technology.
4+
# License: Modified BSD 3-clause – see file "LICENSE" in the project website.
5+
# Website: https://github.com/caltechlibrary/boffo
6+
7+
name: Markdown file linter
8+
run-name: Lint Markdown files after ${{github.event_name}} by ${{github.actor}}
9+
10+
on:
11+
push:
12+
branches:
13+
- main
14+
paths:
15+
- '*.md'
16+
pull_request:
17+
branches:
18+
- main
19+
paths:
20+
- '*.md'
21+
workflow_dispatch:
22+
paths:
23+
- '*.md'
24+
25+
jobs:
26+
lint:
27+
name: Run Markdown linter
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Check out copy of git repository.
31+
uses: actions/checkout@v4
32+
33+
- name: Run Markdownlint on .md files.
34+
uses: DavidAnson/markdownlint-cli2-action@v15
35+
with:
36+
config: .markdownlint.json
37+
globs: |
38+
*.md

‎.github/workflows/yaml-linter.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Summary: GitHub Actions workflow to run a YAML linter on .yml files.
2+
#
3+
# Copyright 2024 California Institute of Technology.
4+
# License: Modified BSD 3-clause – see file "LICENSE" in the project website.
5+
# Website: https://github.com/caltechlibrary/boffo
6+
7+
name: YAML file linter
8+
9+
on:
10+
pull_request:
11+
types: [opened, synchronize]
12+
paths:
13+
- '**.yml'
14+
- '**.yaml'
15+
push:
16+
branches:
17+
- main
18+
paths:
19+
- '**.yml'
20+
- '**.yaml'
21+
22+
run-name: Run linter on YAML files
23+
jobs:
24+
Yamllint:
25+
name: GitHub YAMLlint
26+
runs-on: ubuntu-latest
27+
steps:
28+
- name: Check out copy of git repository
29+
uses: actions/checkout@v4
30+
31+
- name: Run YAMLlint
32+
uses: ibiqlik/action-yamllint@v3.1.1
33+
with:
34+
config_file: .yamllint.yml

‎.gitignore

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,26 @@
1-
# @file .gitignore
2-
# @brief Files and patterns for files and subdirs that git should ignore
3-
# @date 2023-06-12
4-
# @license Please see the file named LICENSE in the project directory
5-
# @website https://github.com/caltechlibrary/boffo
1+
# Summary: rules for files and subdirectories to be ignored by git.
62
#
7-
# The approach we suggest is to add ONLY project-specific rules here. Put
8-
# rules that apply to your way of doing things (and the particular tools you
9-
# happen to use) into a global git ignore file as described in the section
10-
# "Configuring ignored files for all repositories on your computer" here:
11-
# https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files
12-
# (accessed on 2022-07-14). For example, Emacs checkpoint and backup files are
13-
# things that are not specific to a given project; rather, Emacs users will
14-
# see them created everywhere, in all projects, because they're a byproduct
15-
# of using Emacs, not a consequence of working on a particular project. Thus,
16-
# they belong in a user's global ignores list, not in this project .gitignore.
3+
# Copyright 2024 California Institute of Technology.
4+
# License: Modified BSD 3-clause – see file "LICENSE" in the project website.
5+
# Website: https://github.com/caltechlibrary/boffo
176
#
18-
# A useful starting point for global .gitignore file contents can be found at
19-
# https://github.com/github/gitignore/tree/main/Global (as of 2022-07-14).
20-
21-
# Ignore backup files created by our Makefile
22-
# .............................................................................
23-
24-
*.bak
25-
26-
# Project-specific things to ignore:
27-
# .............................................................................
7+
# ╭─────────────────────── Notice ── Notice ── Notice ────────────────────────╮
8+
# │ The recommended approach is to add ONLY project-specific rules to the │
9+
# │ .gitignore of a repo. Users can put rules that apply to their individual │
10+
# │ ways of doing things into global git ignore files that they set up using │
11+
# │ (e.g.) "git config --global core.excludesfile ~/.gitignore_global". For │
12+
# │ example, a number of files such as Emacs checkpoint and backup files are │
13+
# │ things that are not specific to a given project; rather, Emacs creates │
14+
# │ them everywhere, in all projects, because they're a byproduct of how it │
15+
# │ works. Thus, rules to ignore them belong in users' own global .gitignore │
16+
# │ files, not in a project's .gitignore. │
17+
# │ │
18+
# │ A useful starting point for global .gitignore file contents can be found │
19+
# │ at https://github.com/github/gitignore/tree/main/Global (as of 2022-07-14)│
20+
# ╰───────────────────────────────────────────────────────────────────────────╯
2821

2922
docs/_build
23+
*.bak
3024
*.log
3125
*.tmp
3226
.tern-port

‎.jsonlintrc.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"comments": false,
3+
"trailing-commas": false,
4+
"duplicate-keys": false,
5+
"log-files": false,
6+
"compact": true,
7+
"continue": true,
8+
"patterns": ["**/*.json"]
9+
}

‎.markdownlint.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"blank_lines": {
3+
"maximum": 2
4+
},
5+
"html": {
6+
"allowed_elements": [
7+
"a",
8+
"b",
9+
"br",
10+
"code",
11+
"details",
12+
"div",
13+
"em",
14+
"figcaption",
15+
"figure",
16+
"i",
17+
"img",
18+
"ins",
19+
"kbd",
20+
"p",
21+
"span",
22+
"sup",
23+
"summary"
24+
]
25+
},
26+
"line-length": {
27+
"line_length": 10000
28+
},
29+
"no-alt-text": true,
30+
"no-duplicate-heading": {
31+
"allow_different_nesting": true
32+
}
33+
}

0 commit comments

Comments
 (0)