Skip to content

Commit 7104f64

Browse files
iam4tuneiam4tune
authored
Merge pull request #81 from wwarriner/feat-update-machinery
Update machinery, tooling, automation
2 parents 995053a + 57e2b45 commit 7104f64

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+1950
-271
lines changed

‎.github/ISSUE_TEMPLATE/article_request.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Article Request
2+
description: Let us know about articles and sections you would like to see
3+
labels: ["style: article/section 📝"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking time to fill out this report!
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: What would you like to see added?
13+
description:
14+
Please tell us about what article or section you think is missing.
15+
Please include images and links as appropriate, and tell us where you
16+
think the new content would best fit.
17+
placeholder: Tell us what you would like to see!
18+
validations:
19+
required: true

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Bug Report
2+
description: Let us know about bugs!
3+
labels: ["fix: bug 🐞"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking time to fill out this report!
9+
- type: textarea
10+
id: what-happened
11+
attributes:
12+
label: What happened?
13+
description:
14+
Please describe what happened. Screenshots and URLs of affected parts
15+
are welcome.
16+
placeholder: Tell us what you see!
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: what-should-happen
21+
attributes:
22+
label: What should happen instead?
23+
description: Please describe what should have happened.
24+
placeholder: Tell us what you see!
25+
validations:
26+
required: true
27+
- type: dropdown
28+
id: browsers
29+
attributes:
30+
label: What browsers are you seeing the problem on?
31+
multiple: true
32+
options:
33+
- Firefox
34+
- Chrome
35+
- Safari
36+
- Microsoft Edge
37+
- type: dropdown
38+
id: devices
39+
attributes:
40+
label: What devices are you seeing the problem on?
41+
multiple: true
42+
options:
43+
- Windows
44+
- MacOS
45+
- Linux
46+
- Android
47+
- iOS

‎.github/ISSUE_TEMPLATE/inaccuracy_report.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Inaccuracy Report
2+
description: Let us know about inaccurate or outdated information
3+
labels: ["fix: inaccuracy ⚠️"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking time to fill out this report!
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: What is inaccurate?
13+
description: Please describe the inaccuracy. If you can, please tell us what would be an accurate replacement.
14+
placeholder: Tell us what you see!
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: url
19+
attributes:
20+
label: Where is the inaccuracy?
21+
description: Please paste a link to the affected section.
22+
placeholder: Tell us where it is!
23+
validations:
24+
required: true

‎.github/pull_request_template.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Pull Request
2+
3+
## Intent
4+
<!-- Describe the intent of the changes. -->
5+
6+
## Proposed Changes
7+
<!-- Provide specific details of what is changing. -->
8+
9+
### Changes to Section Headers
10+
<!-- Write down which headers have changed.
11+
old-header -> new-header
12+
-->
13+
14+
### Changes to Page URLs
15+
<!-- Write down which pages have changed.
16+
old/page.md -> new/page.md
17+
-->
18+
19+
## Related or Fixed Issues
20+
<!-- Examples:
21+
Fixes #123
22+
Related to #101
23+
-->
24+
25+
## Accessibility Checklist
26+
27+
I have ensured all of the following for new or changed content:
28+
29+
- [ ] all images have appropriate alt text. [Guidelines](https://www.wcag.com/blog/good-alt-text-bad-alt-text-making-your-content-perceivable/)
30+
- [ ] all images with text have sufficient contrast ratio. [Checker](https://webaim.org/resources/contrastchecker/)
31+
- [ ] all image text is transcribed or described in body text.
32+
- [ ] all technical terms, jargon, and abbreviations are introduced before they are used.
33+
34+
## Style Checklist
35+
36+
I have done all of the following:
37+
38+
- [ ] searched for other relevant pages and crosslinked from my content to them.
39+
- [ ] searched for other relevant pages and crosslinked from them to my content.
40+
- [ ] added redirects in `mkdocs.yml` for any moved headers or pages.
41+
- [ ] defined new technical terms, jargon, and abbreviations in the glossary.
42+
- [ ] searched for existing technical terms, jargon, and abbreviations in the glossary and added crosslinks to them.
43+
- [ ] properly formatted and introduced key branding terms. [List here](https://docs.rc.uab.edu/contributing/contributor_guide#terminology).

‎.github/shared/build_docs_pages/action.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# builds mkdocs, reusable by other checks
2+
3+
name: Build Docs Pages
4+
description: Build Docs Pages for mkdocs workflows.
5+
6+
runs:
7+
using: composite
8+
steps:
9+
- uses: conda-incubator/setup-miniconda@835234971496cad1653abb28a638a281cf32541f # 3.2.0
10+
with:
11+
environment-file: build_env.yml
12+
activate-environment: mkdocs
13+
miniforge-version: latest
14+
15+
- name: Build Pages # this is both a build and check step
16+
run: mkdocs build --strict
17+
shell: bash -l {0} # must have -l because conda requires login shell to function in subsequent steps

‎.github/workflows/check_docs.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# checks for mkdocs specific issues
2+
3+
name: docs
4+
5+
on: # yamllint disable-line rule:truthy
6+
pull_request:
7+
branches:
8+
- main
9+
paths:
10+
- "build_env.yml"
11+
- "mkdocs.yml"
12+
- "build_scripts/**"
13+
- "docs/**"
14+
workflow_dispatch:
15+
16+
jobs:
17+
check_markdown:
18+
uses: "./.github/workflows/reusable_check_markdown.yml"
19+
with:
20+
globs: "docs/**/*.md"
21+
check_docs:
22+
needs: check_markdown
23+
runs-on: ubuntu-latest
24+
permissions:
25+
contents: read
26+
steps:
27+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
28+
with:
29+
fetch-depth: 0 # mkdocs-git-revision-date-localized-plugin
30+
- uses: "./.github/shared/build_docs_pages/"

‎.github/workflows/check_python.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# checks python files for python linting and formatting issues
2+
3+
name: python
4+
5+
on: # yamllint disable-line rule:truthy
6+
push:
7+
branches:
8+
- main
9+
paths:
10+
- "**.py"
11+
pull_request:
12+
branches:
13+
- main
14+
paths:
15+
- "**.py"
16+
workflow_dispatch:
17+
18+
jobs:
19+
check_python:
20+
runs-on: ubuntu-latest
21+
permissions:
22+
contents: read
23+
strategy:
24+
matrix:
25+
args: ["check", "format --check --diff"]
26+
steps:
27+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
28+
- uses: astral-sh/ruff-action@eaf0ecdd668ceea36159ff9d91882c9795d89b49 # 3.4.0
29+
with:
30+
args: ${{ matrix.args }}
31+
version: 0.12.0

‎.github/workflows/check_yaml.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# checks yaml for yaml-specific linting and formatting issues
2+
3+
name: yaml
4+
5+
on: # yamllint disable-line rule:truthy
6+
push:
7+
branches:
8+
- main
9+
paths:
10+
- "**.yml"
11+
- "**.yaml"
12+
pull_request:
13+
branches:
14+
- main
15+
paths:
16+
- "**.yml"
17+
- "**.yaml"
18+
workflow_dispatch:
19+
20+
jobs:
21+
check_yaml:
22+
runs-on: ubuntu-latest
23+
permissions:
24+
contents: read
25+
steps:
26+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
27+
- uses: karancode/yamllint-github-action@4052d365f09b8d34eb552c363d1141fd60e2aeb2 # 3.0.0
28+
with:
29+
yamllint_config_filepath: ".yamllint.yaml"
30+
yamllint_strict: true
31+
yamllint_comment: true

‎.github/workflows/ci.yml‎

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎.github/workflows/deploy_docs.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# deploys documentation to gh-pages
2+
3+
name: docs
4+
5+
on: # yamllint disable-line rule:truthy
6+
push:
7+
branches:
8+
- main
9+
paths:
10+
- "build_env.yml"
11+
- "mkdocs.yml"
12+
- "build_scripts/**"
13+
- "docs/**"
14+
workflow_dispatch:
15+
16+
jobs:
17+
check_markdown:
18+
uses: "./.github/workflows/reusable_check_markdown.yml"
19+
with:
20+
globs: "docs/**/*.md"
21+
deploy_docs:
22+
needs: check_markdown
23+
environment:
24+
name: github-pages
25+
url: ${{ steps.deployment.outputs.page_url }}
26+
runs-on: ubuntu-latest
27+
permissions:
28+
contents: read
29+
pages: write
30+
id-token: write
31+
steps:
32+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
33+
with:
34+
fetch-depth: 0 # mkdocs-git-revision-date-localized-plugin
35+
- uses: "./.github/shared/build_docs_pages/"
36+
- uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # 5.0.0
37+
- uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # 3.0.1
38+
with:
39+
path: "./site"
40+
- uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # 4.0.5

0 commit comments

Comments
 (0)