Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
294 commits
Select commit Hold shift + click to select a range
92be3b8
fix reference name; update description
nreinicke Aug 28, 2024
fa9da4b
update url
nreinicke Aug 28, 2024
97f55ed
disclaimer about compass in colorado.
nreinicke Aug 28, 2024
c009536
include example values in documentation
nreinicke Sep 4, 2024
da3bc76
Merge pull request #360 from NREL/meteosat-2022
reger-nrel Sep 5, 2024
31171ac
Adding wtk-conus-5min-v2-0-0-download Documentation (#361)
msherman32 Sep 11, 2024
1d8d61f
Merge pull request #356 from nreinicke/update-routee-api-docs
GUI Sep 11, 2024
17ba9bd
🌴 CV - 8338 - Data Ingestion (#363)
msherman32 Sep 27, 2024
75d4f4e
NSRDB - 8469 - 2023 Data Ingestion (V4.0.0) Documentation (#365)
msherman32 Nov 13, 2024
13ebc84
Adds docs for new WTK LED Climate download (#366)
PjEdwards Nov 15, 2024
69a20cd
🌞 NSRDB - 8543 - Updating GOES 2023 Data Ingestion (V4.0.0) Documenta…
msherman32 Nov 20, 2024
4220de0
Update REopt API documentation page
Bill-Becker Nov 25, 2024
ad59465
Merge pull request #368 from Bill-Becker/main
GUI Nov 25, 2024
10dc09f
Change all URLs from http to https (#369)
PjEdwards Nov 26, 2024
9883a6d
adding wtk indonesia documentation
Dec 24, 2024
a0ccc38
updating the title/summary/detail
Dec 24, 2024
d55ad6b
Add GitHub Action triggers for manual and nightly builds
GUI Dec 30, 2024
bea24fb
Merge pull request #372 from NREL/action-triggers
GUI Dec 30, 2024
0b6f6dd
💨 WTK - 8600 - Adding the WTK BCHRRR Dataset Documentation (#370)
msherman32 Jan 3, 2025
8d7db2a
Merge pull request #371 from msherman32/rede/8601-indonesia-dataset
reger-nrel Jan 15, 2025
5b77ea1
Tweak contact form options for transportation APIs.
GUI Feb 5, 2025
7f93553
Merge pull request #375 from NREL/contact-options
GUI Feb 5, 2025
01a50c1
NSRDB - 8602 - Documentation Update (#377)
msherman32 Feb 18, 2025
25adc74
removing address param from docs
reger-nrel Feb 21, 2025
cb9a90a
Remove references to the `location` query param for fuel station APIs
GUI Feb 22, 2025
8af6124
Merge pull request #380 from NREL/remove-address-param
GUI Feb 22, 2025
f305e11
changing notes re: pvwatts v6 decommissioning date
reger-nrel Mar 10, 2025
8e28a02
Merge pull request #381 from NREL/v6-decom-tbd
reger-nrel Mar 10, 2025
e174a4a
Bump rexml from 3.2.5 to 3.2.8
dependabot[bot] Apr 8, 2025
ede0866
Merge pull request #354 from NREL/dependabot/bundler/rexml-3.2.8
GUI Apr 9, 2025
f397788
Bump rack from 2.2.9 to 2.2.13
dependabot[bot] Apr 9, 2025
990c090
Bump elliptic from 6.5.7 to 6.6.1
dependabot[bot] Apr 9, 2025
f3915b7
Bump @babel/runtime-corejs2 from 7.25.0 to 7.27.0
dependabot[bot] Apr 9, 2025
8526200
Bump @babel/runtime from 7.25.0 to 7.27.0
dependabot[bot] Apr 9, 2025
c31e87f
Bump cross-spawn from 6.0.5 to 6.0.6
dependabot[bot] Apr 9, 2025
e146da8
Merge pull request #384 from NREL/dependabot/bundler/rack-2.2.13
GUI Apr 9, 2025
305a930
Merge pull request #385 from NREL/dependabot/npm_and_yarn/elliptic-6.6.1
GUI Apr 9, 2025
d410b2f
Merge pull request #388 from NREL/dependabot/npm_and_yarn/cross-spawn…
GUI Apr 9, 2025
9973372
Merge pull request #387 from NREL/dependabot/npm_and_yarn/babel/runti…
GUI Apr 9, 2025
d9a2b0d
Merge pull request #386 from NREL/dependabot/npm_and_yarn/babel/runti…
GUI Apr 9, 2025
8e5e199
Add request param for include_ev_charging_units for
littleforest Apr 9, 2025
71f267d
Add response info for ev_charging_units field
littleforest Apr 9, 2025
528681d
Move the connector values to a table within the connectors description
littleforest Apr 9, 2025
b84f929
Add ev_power_kw_min and _max request params for
littleforest Apr 9, 2025
fd46f57
Add include_ev_charging_units to GET station request params
littleforest Apr 9, 2025
12315b9
Move API calls to helper methods
littleforest Apr 10, 2025
1e2126c
Move each request param to a separate partial
littleforest Apr 10, 2025
d70fc7c
Add docs for ev-charging-units API endpoint
littleforest Apr 10, 2025
7325b80
Add response section for ev-charging-units endpoint
littleforest Apr 12, 2025
acfa3d2
Remove deprecated cng-vehicle-classes call
littleforest Apr 14, 2025
e4947fb
Add back in owner_type to common2 request params
littleforest Apr 15, 2025
060b098
Add Guam wind download docs (#390)
PjEdwards Apr 23, 2025
bcf351c
Very WIP: Template upgrade and dev/build upgrades.
GUI Apr 24, 2025
ee3bcf2
Document ids request param for alt-fuel-stations all endpoint
littleforest Apr 24, 2025
778611a
Document maximum_vehicle_class request param
littleforest Apr 24, 2025
39471d9
Document ev_network_station_ids request param
littleforest Apr 24, 2025
484dd73
Add note to pass ev_network key when using ev_network_station_ids param
littleforest Apr 24, 2025
9fd191d
More functional template upgrade work.
GUI Apr 25, 2025
00649b2
Update github actions for updated dependencies.
GUI Apr 25, 2025
f07f126
Don't try to validate vite manifest as swagger.
GUI Apr 25, 2025
5a211b1
Update OpenAPI validator with one that can validate v3.
GUI Apr 25, 2025
7d89ed2
Remove Lab Partnering API docs that seem to be defunct.
GUI Apr 25, 2025
997c128
Fix some OpenAPI spec validation issues new validator found.
GUI Apr 25, 2025
10d2dd8
Merge remote-tracking branch 'origin/main' into template-upgrade
GUI Apr 25, 2025
bc95108
Try to fix deploys.
GUI Apr 25, 2025
e1047e0
Add documentation for funding_sources request param
littleforest Apr 25, 2025
c18bb52
Use loader instead of individual api requests
littleforest Apr 25, 2025
787a5ff
Move all loader requests to methods in config file
littleforest Apr 25, 2025
8591a59
Allow formats partial to take list of formats
littleforest Apr 25, 2025
f28a4d7
Various cleanup and tweaks.
GUI Apr 25, 2025
a431091
Update deploy dependency.
GUI Apr 25, 2025
215c710
Properly fix the header link icons so they stick with the last word.
GUI Apr 26, 2025
870a08a
Add additional comment about possibly overly-complicated icon handling
GUI Apr 28, 2025
693b8cd
Fix content layout flashes by using newer/proper Bootstrap class.
GUI Apr 28, 2025
cbbcd24
Basic eslint setup.
GUI Apr 28, 2025
edac95d
Various fixes and tweaks from feedback.
GUI Apr 29, 2025
9e098d7
Merge pull request #392 from NREL/template-upgrade
GUI Apr 29, 2025
2631af5
follow NREL style for "email" and "website"
mrahill Apr 29, 2025
d7fe0ef
Merge pull request #393 from NREL/nrel-style-for-email-website
GUI Apr 29, 2025
a205a0a
Fix errors in the GOES docs (#394)
PjEdwards May 5, 2025
d8e30c5
Reconcile list of available attributes with API (#395)
PjEdwards May 7, 2025
80e8655
update footer attribution spacing and line height
mrahill May 13, 2025
6ae22d3
Merge pull request #397 from NREL/style-footer-attribution
mrahill May 16, 2025
7761e15
Merge branch 'main' into ev-charging-units-docs
littleforest May 21, 2025
518c191
Remove unneeded classes after docs redesign
littleforest May 21, 2025
f9e2664
Bump rack from 3.1.13 to 3.1.16
dependabot[bot] Jun 5, 2025
1024191
update pvdaq docs
reger-nrel Jun 16, 2025
b11f8e1
adding a decommissioned state (works like deprecated)
reger-nrel Jun 16, 2025
f0caf3a
wording
reger-nrel Jun 17, 2025
84998ee
add alert re: 2012 data in utility rates and no plans to update'
reger-nrel Jun 17, 2025
3cb6d94
add alert re: 2012 data in census rates and no plans to update'
reger-nrel Jun 17, 2025
3af8d63
remove words
reger-nrel Jun 17, 2025
01c937f
Merge pull request #401 from NREL/pvdaq-updates
reger-nrel Jun 30, 2025
1fc6f63
Adds the year 2024 to relevant NSRDB docs (#403)
PjEdwards Jul 1, 2025
4a2c168
Update footer text.
susanna-carey Jul 10, 2025
6762801
Merge pull request #404 from susannaopal/footer-text-update
mrahill Jul 10, 2025
b5a0563
Update language for intro and footer
susanna-carey Jul 15, 2025
1333829
Merge remote-tracking branch 'upstream/main' into update-nrel-text
susanna-carey Jul 15, 2025
e6a79ed
Merge pull request #405 from susannaopal/update-nrel-text
mrahill Jul 15, 2025
b5c3f85
Fix broken BCL link; Remove defunct API docs
GUI Jul 16, 2025
bbc1304
Merge pull request #406 from NREL/buildings-cleanup
GUI Jul 16, 2025
3696c1a
clean up footer style overrides
mrahill Jul 21, 2025
3c545a1
Merge pull request #407 from NREL/clean-up-footer-style-overrides
mrahill Jul 22, 2025
334c157
Bump thor from 1.2.2 to 1.4.0
dependabot[bot] Jul 22, 2025
69fea8d
Merge pull request #408 from NREL/dependabot/bundler/thor-1.4.0
GUI Jul 22, 2025
23bd8cf
Merge pull request #399 from NREL/dependabot/bundler/rack-3.1.16
GUI Jul 22, 2025
dfd52fa
Bump vite from 5.4.18 to 5.4.19
dependabot[bot] Jul 22, 2025
778bac8
Add documentation for electric-networks API endpoint
littleforest Apr 25, 2025
101aa71
Pass resource name into country request partial
littleforest Apr 25, 2025
76c7a84
Add J3271 connector count and power output fields to ev-charging-unit…
littleforest Jul 22, 2025
6457e1c
Minor copy changes
littleforest Jul 22, 2025
f9ce9bb
Minor heading copy change
littleforest Jul 22, 2025
d0428c3
Capitalize ID
littleforest Jul 22, 2025
a5b5eaa
Add hyphen
littleforest Jul 22, 2025
1a3fca1
Minor title change for ev-charging-units endpoint
littleforest Jul 22, 2025
46ea65a
Use "EV" instead of "electric" in summary
littleforest Jul 22, 2025
4a2d972
Use "EV" instead of "electric"
littleforest Jul 22, 2025
39a4de0
Use "EV" instead of "electric"
littleforest Jul 22, 2025
7a7dcfd
Use "EV" instead of "electric"
littleforest Jul 22, 2025
2206e14
Use "EV" instead of "electric"
littleforest Jul 22, 2025
1e169b4
Update title and summary for electric-networks endpoint
littleforest Jul 22, 2025
64b3996
Minor copy changes
littleforest Jul 22, 2025
7aea9d6
Minor copy changes
littleforest Jul 22, 2025
740f421
Minor copy changes
littleforest Jul 22, 2025
6f3bf7d
Add AFDC acronym to description
littleforest Jul 22, 2025
3bf0095
Fix TOC on electric-networks and ev-charging-units
littleforest Jul 22, 2025
b21e307
update content for stations API documentation
mrahill Jul 24, 2025
e15b69e
Fix broken anchor link to EV network ID fields
littleforest Jul 24, 2025
e8a6003
update anchor link wording for EV charging network ID record fields
mrahill Jul 25, 2025
97e1a7c
Merge pull request #409 from NREL/dependabot/npm_and_yarn/vite-5.4.19
GUI Jul 28, 2025
6613acc
Be more explicit about the request value for include_ev_charging_unit…
littleforest Jul 29, 2025
dec8bc2
Prefix global helpers with alt_fuel_stations_ to avoid conflicts
littleforest Jul 29, 2025
53afa2f
Remove redundant cng/lng_vehicle_classes methods
littleforest Jul 29, 2025
a3047e4
Note charging port info available in All API on CSV-only docs
littleforest Jul 29, 2025
704e595
Add funding_sources response info at station level
littleforest Jul 29, 2025
538a4b6
Fix typo: 'any array' -> 'an array'
littleforest Jul 29, 2025
d9f0e7e
Designate sort order for list of Alt Fuel Station endpoints
littleforest Jul 29, 2025
2dd4e1b
Wave/new dataset (#411)
PjEdwards Aug 6, 2025
282184f
Remove note in summary about passing include_ev_charging_units param
littleforest Aug 6, 2025
00b245d
Remove reference to include_ev_charging_units param in response details
littleforest Aug 6, 2025
a0084de
Copy changes for ev-charging-units response
littleforest Aug 22, 2025
5e311f0
Add documentation for inlude_inactive request param for electric-netw…
littleforest Aug 6, 2025
8151636
Add facility_type request param to alt-fuelt-stations endpoints
littleforest Jul 29, 2025
954a357
Add hyphen in comma-separated
littleforest Aug 22, 2025
7275317
Add hyphen in comma-separated
littleforest Aug 22, 2025
38b9260
Add hyphen in comma-separated
littleforest Aug 22, 2025
eeb41f4
Add hyphen in comma-separated
littleforest Aug 22, 2025
b1e1370
Add hyphen in comma-separated
littleforest Aug 22, 2025
937b4b8
Merge pull request #389 from littleforest/ev-charging-units-docs
mrahill Aug 22, 2025
5c16cf2
Document response_format=compact for all, nearest endpoints
littleforest Aug 25, 2025
acc9c0a
Add correct default for limit for nearest endpoint
littleforest Aug 25, 2025
357e221
Update copy for response_format request param description
littleforest Aug 25, 2025
c492c13
Do not italicize default of None
littleforest Aug 25, 2025
e7c712c
Use partial for limit request_param and pass in default
littleforest Aug 25, 2025
5d3891b
Add note that all cannot be passed if radius is infinite for nearest …
littleforest Aug 25, 2025
84232c6
Use partial instead of render_partial when passing local vars
littleforest Aug 26, 2025
daa9e58
Merge pull request #414 from littleforest/response-format-nearest-lim…
littleforest Aug 26, 2025
958eca1
Update new response fields for electric-networks re transitions
littleforest Sep 3, 2025
23459bc
Update electric-networks exampple response after adding transition fi…
littleforest Sep 3, 2025
5771f94
Alphabetize the transition_ params to match API response
littleforest Sep 5, 2025
9facf11
Update example response with reordered keys
littleforest Sep 5, 2025
637609a
Merge pull request #415 from littleforest/document-new-electric-netwo…
littleforest Sep 8, 2025
a777d16
fix example URL for EV charging networks API endpoint
mrahill Sep 10, 2025
2ec3fdb
Merge pull request #417 from NREL/fix-example-url-for-ev-charging-net…
mrahill Sep 10, 2025
4c7c2b6
Bump rexml from 3.4.1 to 3.4.2
dependabot[bot] Sep 17, 2025
6d5e417
🌞 NSRDB - Feat/nsrdb polar data docs (#416)
PjEdwards Sep 22, 2025
df24068
Adds docs for new Sup3rwind South America endpiont (#422)
PjEdwards Oct 10, 2025
03c3756
Bump vite from 5.4.19 to 5.4.21
dependabot[bot] Oct 21, 2025
20e669b
Remove deprecated (#424)
PjEdwards Oct 21, 2025
0fc541b
Merge pull request #419 from NREL/dependabot/bundler/rexml-3.4.2
littleforest Oct 29, 2025
42ebdb1
Bump rack from 3.1.16 to 3.1.18
dependabot[bot] Oct 29, 2025
07cb011
Merge pull request #421 from NREL/dependabot/bundler/rack-3.1.18
littleforest Oct 29, 2025
699e857
🌬️ Add docs for WTK Sup3rWind South America 60 minute (#427)
PjEdwards Nov 6, 2025
ff85833
Adds CNMI and Guam wave download endpoint doc
pedwards-nrel Nov 21, 2025
e18dc1f
switch main NREL references to NLR
mrahill Dec 3, 2025
baa0663
switch logo from SVG to WEBP
mrahill Dec 3, 2025
b42f293
finish switching NREL references to NLR
mrahill Dec 3, 2025
1251be4
Merge pull request #429 from NREL/nrel-to-nlr
mrahill Dec 4, 2025
4717d4c
update the footer attribution
mrahill Dec 4, 2025
9196b97
Merge pull request #431 from NREL/footer-attribution-update
mrahill Dec 4, 2025
f2c8b6a
update alliance name
mrahill Dec 11, 2025
9a5093b
Merge pull request #423 from NREL/dependabot/npm_and_yarn/vite-5.4.21
littleforest Dec 11, 2025
5704160
Merge pull request #432 from NREL/update-alliance-name
mrahill Dec 11, 2025
6523875
Remove references to XML and KML formats for alt-fuel-stations endpoints
littleforest Dec 11, 2025
4260026
Merge pull request #430 from NREL/remove-xml-kml-for-alt-fuel-stations
littleforest Dec 11, 2025
1b92312
Add related_stations to the alt-fuel-stations response
littleforest Oct 28, 2025
14186b6
Update example responses
littleforest Oct 28, 2025
2920e3a
Modify GET station example for one with funding_sources, related_stat…
littleforest Dec 11, 2025
afa73fd
Modify GET all stations example for one with funding_sources, related…
littleforest Dec 12, 2025
5147998
Modify 'all' examples to include one with ev_network_ids in response
littleforest Dec 12, 2025
3b59b0d
Update examples for nearest endpoint to include more response values
littleforest Dec 12, 2025
218e951
Update examples for nearby endpoint to include more response values
littleforest Dec 12, 2025
a009620
Fix limit in GeoJSON, CSV nearest examples
littleforest Dec 12, 2025
ce71ac0
Merge pull request #425 from NREL/related-stations-docs
littleforest Dec 16, 2025
e236af7
change EERE to CMEI
mrahill Dec 18, 2025
fcff8e5
Merge pull request #434 from NREL/eere-to-cmei
mrahill Dec 18, 2025
de095f3
adding polar dataset note to docs
reger-nrel Jan 29, 2026
5213b11
Merge pull request #440 from NatLabRockies/polar-solar
reger-nrel Jan 29, 2026
d6d11e4
Add Ukraine Sup3rwind 60 minute
pedwards-nrel Jan 30, 2026
57065f0
Various updates to sync with latest data
pedwards-nrel Jan 30, 2026
b8ac3a0
Adds Sup3rCC documentation
pedwards-nrel Feb 7, 2026
27cd884
Fix deployments; Update GitHub organization name references.
GUI Feb 9, 2026
40ba1db
Merge pull request #444 from NatLabRockies/nlr
GUI Feb 9, 2026
3305f81
Update dependencies.
GUI Feb 9, 2026
cecb483
Merge pull request #445 from NatLabRockies/dep-updates
GUI Feb 9, 2026
bfbdbb1
update Alliance logo and NLR links in the header and footer
mrahill Feb 11, 2026
b9ac0c2
update NLR links and email addresses
mrahill Feb 11, 2026
44dc7a0
Adjust image sizes to match NREL template.
GUI Feb 11, 2026
7c25d7f
tweak margins for horizontal rule in the footer
mrahill Feb 12, 2026
ac43876
Merge pull request #446 from NatLabRockies/alliance-logo-and-link-upd…
mrahill Feb 12, 2026
4f56263
update footer links
mrahill Feb 12, 2026
adc8195
Merge pull request #447 from NatLabRockies/update-footer-links
mrahill Feb 12, 2026
ef0b98c
Fix `nearby-route`'s `route` param not being marked as required.
GUI Feb 13, 2026
38b6eb9
Merge pull request #448 from NatLabRockies/nearby-route
GUI Feb 13, 2026
5d1ed93
Update REopt.jl docs link to new URL
hdunham Feb 17, 2026
61ac7c7
Merge pull request #449 from hdunham/patch-1
GUI Feb 17, 2026
f004fe1
Fix broken links to GitHub pages sites due to org rename
GUI Feb 17, 2026
4ca6164
Merge pull request #450 from NatLabRockies/github-pages-links
GUI Feb 17, 2026
c2db783
Bump rack from 3.2.4 to 3.2.5
dependabot[bot] Feb 17, 2026
8a96274
Fix broken swagger docs.
GUI Feb 18, 2026
3a15f18
Soft deprecate XML formats for transportation APIs.
GUI Feb 18, 2026
cab5f26
Merge pull request #452 from NatLabRockies/fix-swagger
GUI Feb 18, 2026
9d8ceb1
Merge pull request #453 from NatLabRockies/soft-deprecate-xml
GUI Feb 19, 2026
3c27a4a
Merge pull request #451 from NatLabRockies/dependabot/bundler/rack-3.2.5
GUI Feb 19, 2026
57ba00b
Remove docs for invalid endpoint
pedwards-nrel Feb 25, 2026
c6f0d2e
Update references to developer.nlr.gov domain
GUI Feb 26, 2026
332de8a
Merge pull request #455 from NatLabRockies/nlr
GUI Feb 26, 2026
6b12217
Add banner and page explaining domain transition plans.
GUI Mar 4, 2026
cbc68a7
Merge pull request #458 from NatLabRockies/nlr-banner
GUI Mar 4, 2026
94652a4
add a page about updating embed code for NLR.gov widgets
mrahill Mar 9, 2026
f807850
Merge pull request #459 from NatLabRockies/widget-embed-code
mrahill Mar 9, 2026
7bd22a8
Remove light-duty vehicles from API documentation.
susanna-carey Mar 26, 2026
5e23edf
Announce shutdown date for Utility Rates by Census Region API
GUI Mar 30, 2026
b500b3e
Merge pull request #463 from NatLabRockies/deprecate-census
GUI Mar 30, 2026
c2b6a90
Replace links with nlr.gov addresses in VADR endpoints
pedwards-nrel Mar 4, 2026
cfcec06
Adds docs for HRRR MET downloads
pedwards-nrel Apr 10, 2026
f227d99
NREL to NLR
PjEdwards Apr 13, 2026
3ffab8b
Bulk fix WRDB email address
pedwards-nrel Apr 16, 2026
e638900
update developer.nlr.gov references
mrahill Apr 16, 2026
a4588b3
rename nlr-app-template directory and files
mrahill Apr 16, 2026
0b0732f
update files from Bootstrap 5 template
mrahill Apr 16, 2026
e545e76
make updates shared from NLR.gov standards team
mrahill Apr 16, 2026
b8fc2b4
Merge pull request #471 from NatLabRockies/new-nlr-branding
mrahill Apr 17, 2026
0a27fa7
Merge branch 'main' into remove-light-duty-vehicle-documentation
mrahill Apr 17, 2026
36be134
bring back documentation for the vehicle manufacturers endpoint
mrahill Apr 17, 2026
1783be4
remove parameters for the manufacturers endpoint docs specific to lig…
mrahill Apr 17, 2026
62d63fd
update description for vehicles response
mrahill Apr 17, 2026
ab7a31d
Merge pull request #462 from NatLabRockies/remove-light-duty-vehicle-…
mrahill Apr 17, 2026
e2fe20b
Remove API docs for deprecated census rates API.
GUI Apr 20, 2026
2dd7f7b
Merge pull request #472 from NatLabRockies/rm-census-rates
GUI Apr 20, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 4 additions & 3 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.git
tmp
node_modules
/.git
/build
/node_modules
/tmp
41 changes: 25 additions & 16 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
name: CI

on: [push, pull_request]
on:
push:
pull_request:
workflow_dispatch:
schedule:
- cron: "8 5 * * *"

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
submodules: recursive

- uses: ruby/setup-ruby@v1
with:
ruby-version: "2.7"
ruby-version: "3.4"
bundler-cache: true

- uses: actions/setup-node@v2
- uses: pnpm/action-setup@v4

- uses: actions/setup-node@v4
with:
node-version: "14"
cache: yarn
cache-dependency-path: "**/yarn.lock"
node-version: "22"
cache: pnpm

# Yarn dependencies
- name: Yarn Install
run: yarn install
# NPM dependencies
- name: pnpm Install
run: pnpm install

# Build
- name: Set production DEPLOY_ENV
Expand All @@ -38,11 +44,14 @@ jobs:
run: bundle exec middleman build --clean --verbose --environment=${{ env.DEPLOY_ENV }}

# Lint
- name: JS Lint
run: pnpm run lint

- name: Lint
run: bundle exec rake lint

# Artifact
- uses: actions/upload-artifact@v1
- uses: actions/upload-artifact@v4
if: success() && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/staging')
with:
name: build
Expand All @@ -54,17 +63,17 @@ jobs:
if: success() && github.ref == 'refs/heads/main'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: yarn run gh-pages --dist ./build/ --branch build-history --user "$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" --repo "https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
run: pnpm exec gh-pages --dist ./build/ --branch build-history --user "$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" --repo "https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"

deploy:
if: success() && github.repository_owner == 'NREL' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/staging')
if: success() && github.repository_owner == 'NatLabRockies' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/staging')
needs: build
runs-on: ubuntu-latest
container:
image: rclone/rclone:1.57.0
steps:
# Deploy to S3 bucket.
- uses: actions/download-artifact@v1
- uses: actions/download-artifact@v4
with:
name: build
path: ./build
Expand All @@ -89,7 +98,7 @@ jobs:
--s3-no-check-bucket \
--s3-no-head \
--header-upload "Cache-Control: public, max-age=31536000, immutable" \
--include "/assets/**" \
--include "/vite/assets/**" \
./build/ \
"$S3_DEST"
# Sync the remaining files, disallowing caching on those.
Expand All @@ -113,6 +122,6 @@ jobs:
--no-update-modtime \
--s3-no-check-bucket \
--s3-no-head \
--exclude "/assets/**" \
--exclude "/vite/assets/**" \
./build/ \
"$S3_DEST"
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,9 @@

/tmp
/docker-compose.override.yml

# Vite Ruby
/public/vite*
# Vite uses dotenv and suggests to ignore local-only env files. See
# https://vitejs.dev/guide/env-and-mode.html#env-files
*.local
1 change: 1 addition & 0 deletions .spectral.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
extends: ["spectral:oas"]
64 changes: 41 additions & 23 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,38 +1,56 @@
FROM ruby:2.7-bullseye
FROM public.ecr.aws/docker/library/ruby:3.4-slim-trixie

ENV \
BUNDLE_JOBS=4 \
BUNDLE_RETRY=3 \
BUNDLE_JOBS=20 \
BUNDLE_RETRY=5 \
DOCKER=true \
NODE_OPTIONS=--use-openssl-ca \
NODE_MODULES_DIR=/usr/local/node_modules
NODE_MODULES_DIR=/usr/local/node_modules \
NODE_OPTIONS="--use-openssl-ca --openssl-shared-config" \
PNPM_HOME=/usr/local/pnpm

# Determine Debian version
RUN apt-get update && apt-get -y install lsb-release
# Build dependencies
RUN apt-get update && \
apt-get -y --no-install-recommends install build-essential curl && \
rm -rf /var/lib/apt/lists/* /var/lib/dpkg/*-old /var/cache/* /var/log/*

# NodeJS and Yarn
# Install NLR root certs for machines running on NLR's network.
ARG NREL_ROOT_CERT_URL_ROOT=""
RUN set -x && \
VERSION=node_14.x && \
DISTRO="$(lsb_release -s -c)" && \
curl -sSk https://deb.nodesource.com/gpgkey/nodesource.gpg.key | apt-key add - && \
echo "deb http://deb.nodesource.com/$VERSION $DISTRO main" > /etc/apt/sources.list.d/nodesource.list && \
echo "deb-src http://deb.nodesource.com/$VERSION $DISTRO main" >> /etc/apt/sources.list.d/nodesource.list && \
curl -sSk https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
echo "deb http://dl.yarnpkg.com/debian/ stable main" > /etc/apt/sources.list.d/yarn.list && \
if [ -n "$NREL_ROOT_CERT_URL_ROOT" ]; then \
curl -fsSLk -o /usr/local/share/ca-certificates/nrel_root.crt "${NREL_ROOT_CERT_URL_ROOT}/nrel_root.pem" && \
curl -fsSLk -o /usr/local/share/ca-certificates/nrel_xca1.crt "${NREL_ROOT_CERT_URL_ROOT}/nrel_xca1.pem" && \
update-ca-certificates; \
fi

# NodeJS and pnpm
ARG NODEJS_MAJOR_VERSION=24
RUN set -x && \
version="node_${NODEJS_MAJOR_VERSION}.x" && \
distro=$(. /etc/os-release && echo "$VERSION_CODENAME") && \
curl -fsSL -o /usr/share/keyrings/nodesource.asc https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key && \
echo "deb [signed-by=/usr/share/keyrings/nodesource.asc] https://deb.nodesource.com/$version nodistro main" > /etc/apt/sources.list.d/nodesource.list && \
apt-get update && \
apt-get -y install nodejs yarn
ENV NODE_OPTIONS --use-openssl-ca
apt-get -y --no-install-recommends install nodejs && \
corepack enable && \
mkdir -p ~/.config/pnpm && \
printf "update-notifier=false\ncafile=/etc/ssl/certs/ca-certificates.crt\nstore-dir=${PNPM_HOME}/store\n" > ~/.config/pnpm/rc && \
mkdir -p "${NODE_MODULES_DIR}/.pnpm" && \
rm -rf /var/lib/apt/lists/* /var/lib/dpkg/*-old /var/cache/* /var/log/* /root/.npm

RUN mkdir -p /app
WORKDIR /app

# Install gems (all gems first for better Docker caching for CI/CD).
COPY Gemfile Gemfile.lock /app/
RUN bundle install --jobs=20 --retry=5

COPY package.json yarn.lock /app/
RUN mkdir -p "$NODE_MODULES_DIR" && \
RUN bundle install
ARG BUNDLE_INSTALL_ARGS="--frozen --without=development test"
RUN set -x && bundle install $BUNDLE_INSTALL_ARGS && bundle clean --force --verbose

# Install NPM dependencies.
COPY package.json pnpm-lock.yaml /app/
ARG PNPM_INSTALL_ARGS="--frozen-lockfile"
RUN --mount=type=cache,target=/usr/local/pnpm/store set -x && \
ln -s "$NODE_MODULES_DIR" /app/node_modules && \
yarn
pnpm install $PNPM_INSTALL_ARGS

COPY . /app

Expand Down
16 changes: 10 additions & 6 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
source "https://rubygems.org"

ruby "~> 3.4.0"

# Middleman Gems
gem "middleman", "~> 4.4.2"
gem "middleman-livereload", "~> 3.4.6"
gem "middleman", "~> 4.6.2"

# GitHub-flavored markdown.
gem "kramdown-parser-gfm", "~> 1.1.0"

# Environment specific config with environment variables
gem "dotenv", "~> 2.7.2"
gem "dotenv", "~> 3.2.0"

# Syntax highlighting
gem "middleman-syntax", "~> 3.2.0"
gem "middleman-syntax", "~> 3.6.1"

# Redirects
gem "middleman-alias", "~> 0.0.17"

# JSON validation
gem "multi_json", "~> 1.15.0"
gem "multi_json", "~> 1.19.1"

# Test tasks
gem "rake", "~> 13.0"
gem "rake", "~> 13.3"

# For making API calls to generate docs.
gem "rest-client", "~> 2.1.0"

# Use Vite for assets.
gem "vite_padrino", "~> 3.0.0"
Loading