Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
0142a56
refactor: change edit page target to `main` branch
BBeltz1 Jul 23, 2026
bab8302
refactor: change build book trigger to `main` branch
BBeltz1 Jul 23, 2026
caea8d1
refactor: change verify PR action to trigger on `main`
BBeltz1 Jul 23, 2026
a060fc1
fix: reference `main` branch in the `how_we_published` page
BBeltz1 Jul 23, 2026
d8edde7
chore: add pull request template for standard branching
BBeltz1 Jul 23, 2026
08084a8
chore: add template for blank issues
BBeltz1 Jul 23, 2026
c19c68d
chore: rewrite bug report issue template with new fields
BBeltz1 Jul 23, 2026
9052182
chore: disable blank issue use
BBeltz1 Jul 23, 2026
fcce8cb
chore: add feature request issue template
BBeltz1 Jul 23, 2026
f2f6598
chore: add pull request template for syncing `dev` and `main`
BBeltz1 Jul 23, 2026
a331aa6
docs: add standard code of conduct
BBeltz1 Jul 23, 2026
45d1a4c
docs: add standard contributing guidelines
BBeltz1 Jul 23, 2026
d6455bd
docs: rewrite README with new information and new links
BBeltz1 Jul 23, 2026
4bc56c5
docs: reduce excess space in maintainer table
BBeltz1 Jul 23, 2026
d1b79b0
docs: switch maintainer images to html for correct resizing
BBeltz1 Jul 23, 2026
aae2081
docs: expand README title and link to online document
BBeltz1 Jul 23, 2026
c3f10f5
Merge pull request #175 from NOAA-EDAB/refactor/i174-master-to-main
andybeet Jul 23, 2026
3cb3573
Merge pull request #180 from NOAA-EDAB/docs/i178-deploy-repo-docs
andybeet Jul 24, 2026
028bf4f
chore: remove automatic assignment
BBeltz1 Jul 24, 2026
7019432
build: update workflow triggers and bump action versions
BBeltz1 Jul 24, 2026
2935a79
build: bump checkout action version
BBeltz1 Jul 24, 2026
3ef6808
build: add changelog scan to verify PR workflow
BBeltz1 Jul 24, 2026
5c02b00
Merge pull request #182 from NOAA-EDAB/build/i181-redefine-workflows
andybeet Jul 24, 2026
1412db4
Merge pull request #177 from NOAA-EDAB/chore/i176-deploy-templates
andybeet Jul 24, 2026
5ffbd2d
style: add air.toml file to homogenize autoformatting
BBeltz1 Jul 24, 2026
baebb85
style: create workflow to check formatting
BBeltz1 Jul 24, 2026
486f29a
style: create workflow to suggest formatting corrections in PRs
BBeltz1 Jul 24, 2026
df609b4
style: reformat entire codebase
BBeltz1 Jul 27, 2026
5f344ca
Merge pull request #183 from NOAA-EDAB/style/i179-air-reformatting
andybeet Jul 27, 2026
6fc528d
build: increment to new major version
BBeltz1 Jul 29, 2026
cd05938
build: change `quiet` argument to false
BBeltz1 Jul 29, 2026
cd030d2
docs: add release notes for v8.0.0
BBeltz1 Jul 29, 2026
d5dd14a
build: add chapters folder to changelog target
BBeltz1 Jul 29, 2026
729a63d
docs: unnumber release notes subheader
BBeltz1 Jul 29, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/blank_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Blank issue
description: Create a new issue from scratch
body:
- type: markdown
attributes:
value: |
Thank you for contributing an issue to our project!
- type: markdown
attributes:
value: |
If you are reporting a bug or requesting a feature, please click "Choose a different template" above.
- type: textarea
id: description
attributes:
label: Description
validations:
required: true
76 changes: 61 additions & 15 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,77 @@
name: SOE Tech Doc - Bug Report
description: Use this issue template to report bugs in the State of the Ecosystem technical documentation.
title: "[Bug Report]: "
name: Bug Report
description: Identify a problem or unexpected outcome
title: "[Bug]: "
labels: ["bug"]
assignees: "BBeltz1"
body:
- type: markdown
- type: textarea
id: bug-description
attributes:
label: Bug description
description: Please explain the problem you are experiencing
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of our product are you using?
placeholder: X.X.X
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: Operating system
description: What operating system are you using?
options:
- Windows
- Mac
- Linux
validations:
required: true
- type: textarea
id: system-info
attributes:
label: System information
description: Please provide the following system information
value: |
Please use the fields below to identify the bug and provide related information we can use to troubleshoot. Thanks.
- R version:
- IDE:
- IDE version:
validations:
required: true
- type: textarea
id: bugdesc
id: reproduction-steps
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
label: Reproduction steps
description: Please explain the steps required to reproduce the problem. Ideally, include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading <https://www.tidyverse.org/help/#reprex>.
validations:
required: true
- type: textarea
id: bugdisc
id: actual-result
attributes:
label: Describe the situation
description: How did you discover this bug? What were you trying to accomplish?
label: Actual result
description: What is the observed outcome of following the steps above?
validations:
required: true
- type: textarea
id: addinfo
id: expected-result
attributes:
label: Expected result
description: What outcome did you expect from following the steps above?
validations:
required: true
- type: input
id: bug-impact
attributes:
label: Bug impact
description: How severely does this problem impact you and/or your work?
validations:
required: true
- type: upload
id: screenshots
attributes:
label: Additional information
description: Add any other information about the problem here.
label: Upload screenshots
description: If applicable, you may upload screenshots to demonstrate the problem.
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Feature Request
description: Request the addition of a new feature
title: "[Feature]: "
labels: ["feature"]
body:
- type: textarea
id: feature-description
attributes:
label: Feature description
description: Please explain the feature you are requesting
validations:
required: true
- type: textarea
id: feature-reason
attributes:
label: Justification
description: How would this feature improve your use of our product?
validations:
required: true
- type: textarea
id: example-features
attributes:
label: Examples
description: If applicable, please provide an example of the feature. If you have seen or used an analagous feature elsewhere, please provide a link to it.
validations:
required: false
- type: upload
id: screenshots
attributes:
label: Upload screenshots
description: If applicable, you may upload screenshots to supplement your request.
validations:
required: false
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/page_edit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ name: State of the Ecosystem - Edit Tech Doc Page
description: Use this issue template to suggest an edit to a page in the State of the Ecosystem technical documentation.
title: "[Tech Doc Page Edit]: "
labels: ["page edit"]
assignees: "BBeltz1"
body:
- type: markdown
attributes:
Expand Down
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/techdoc_submission.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ name: State of the Ecosystem - Tech Doc Submission
description: Use this issue template to submit tech doc information for the State of the Ecosystem reports.
title: "[Submission]: "
labels: ["submission"]
assignees: "BBeltz1"
body:
- type: markdown
attributes:
Expand Down
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/dev_pr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
PRs into `dev` contained all necessary info. They have already been approved.
Please provide the information below so `main` can be synced with `dev`:

### List PRs

List the PRs that were merged into `dev` that will be pulled into `main` and any issues they fix:

* PR #? which fixes #?

### Types of changes

What types of changes does this pull request introduce? Put an `x` in the boxes that apply.
This will inform the new release number.

- [ ] Fix (non-breaking change which fixes a bug)
- [ ] Feature (non-breaking change which adds or changes functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Other change (if none of the other choices apply)

### Reviewer instructions

The underlying PRs should have been reviewed. Please check that the proposed merge is correct before approving.
If any checkboxes other than "Other change" have been selected please prepare the following file changes for a new release version:
- [ ] changelog.Rmd - add release notes
- [ ] DESCRIPTION - increment the version number according to [Semantic Versioning](https://semver.org)
36 changes: 36 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Your commits explain the `who`, `what`, `where` and `when` of these changes. Your code shows the `how`. You do not need to reiterate this. This PR should complete the picture by explaining `why` these changes are necessary.
Please complete the fields below, replacing or removing placeholder text where necessary:

### Justification

Please describe the importance/impact of the problem and a description of how the changes in this pull request will address, resolve or improve it. This section should sufficiently explain to reviewers why these changes should be approved.
If the proposed changes should close an issue, be sure to link to it below:
Fixes #?

### Types of changes

What types of changes does this pull request introduce? Put an `x` in the boxes that apply.
This will inform the new release number.

- [ ] Fix (non-breaking change which fixes a bug)
- [ ] Feature (non-breaking change which adds or changes functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Other change (if none of the other choices apply)

### Further comments

If this is a relatively large or complex change, kick off a discussion by explaining why you chose the solution you did, what alternatives you considered, problems you may have encountered, etc.

### Reviewer instructions

Assign at least 2 reviewers:
* one of which should be a maintainer of this repo,
* the others should be familiar with the subject or problem.

Please detail the process reviewers will need to follow to properly test these changes. It is especially helpful to identify the exact code needed to conduct a local build/review/test and to specify any aspects of the testing that may not be obvious.

### Formatting

This repo contains an `air.toml` file that automatically formats code to a set of standards.
It is preferred that contributors and reviewers install the [Air](https://posit-dev.github.io/air/) formatting tool.
Code submitted in this pull request will be automatically checked for correct formatting.
15 changes: 5 additions & 10 deletions .github/workflows/bookdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,8 @@
on:
push:
branches:
- master
- dev

pull_request:
branches:
- master

- main
workflow_dispatch:

name: build-book

Expand All @@ -22,7 +17,7 @@ jobs:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v6

- uses: r-lib/actions/setup-pandoc@v2

Expand All @@ -33,10 +28,10 @@ jobs:
- uses: r-lib/actions/setup-r-dependencies@v2

- name: Build book
run: Rscript -e 'bookdown::render_book("index.Rmd", quiet = TRUE)'
run: Rscript -e 'bookdown::render_book("index.Rmd", quiet = FALSE)'

- name: Deploy to gh-pages
uses: JamesIves/github-pages-deploy-action@v4
uses: JamesIves/github-pages-deploy-action@v4.8.0
with:
GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
Expand Down
24 changes: 24 additions & 0 deletions .github/workflows/format-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Workflow derived from https://github.com/posit-dev/setup-air/tree/main/examples

on:
push:
branches: [main, dev]
pull_request:
workflow_dispatch:

name: format-check.yaml

permissions: read-all

jobs:
format-check:
name: format-check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6

- name: Install
uses: posit-dev/setup-air@v1

- name: Check
run: air format . --check
31 changes: 31 additions & 0 deletions .github/workflows/format-suggest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Workflow derived from https://github.com/posit-dev/setup-air/tree/main/examples

on:
pull_request:

name: format-suggest.yaml

jobs:
format-suggest:
name: format-suggest
runs-on: ubuntu-latest

permissions:
# Required to push suggestion comments to the PR
pull-requests: write

steps:
- uses: actions/checkout@v6

- name: Install
uses: posit-dev/setup-air@v1

- name: Format
run: air format .

- name: Suggest
uses: reviewdog/action-suggester@v1
with:
level: error
fail_level: error
tool_name: air
2 changes: 1 addition & 1 deletion .github/workflows/secretScan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ jobs:
gitleaks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v6
with:
fetch-depth: '2'
- name: gitleaks-action
Expand Down
7 changes: 6 additions & 1 deletion .github/workflows/verify_pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Run PR Checks
on:
pull_request:
branches:
- master
- main

jobs:
check_description:
Expand All @@ -13,3 +13,8 @@ jobs:
uses: takanuva15/verify-file-updated@v1
with:
filename_to_check: DESCRIPTION

- name: Verify Changelog Updated
uses: takanuva15/verify-file-updated@v1
with:
filename_to_check: chapters/changelog.Rmd
Loading
Loading