use secrets api key in gha

cole-brokamp · Jul 5, 2024 · 167666c · 167666c
1 parent e3b29d8
commit 167666c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -29,6 +29,7 @@ jobs:
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       R_KEEP_PKG_SOURCE: yes
+      PURPLE_AIR_API_KEY: ${{ secrets.PURPLE_AIR_API_KEY }}
 
     steps:
       - uses: actions/checkout@v4

diff --git a/README.Rmd b/README.Rmd
@@ -31,6 +31,8 @@ Install the development version of PurpleAir with:
 pak::pak("cole-brokamp/PurpleAir")
 ```
 
+Querying data from the PurpleAir API requires a free [PurpleAir Developer API key](https://develop.purpleair.com/sign-in?redirectURL=%2Fdashboards%2Fkeys) linked to a Google account.
+
 ## Usage
 
 ```{r}
-Original file line number
+Diff line change
@@ Expand Up / @@ -31,6 +31,8 @@ Install the development version of PurpleAir with: @@
     pak::pak("cole-brokamp/PurpleAir")
     ```
+    Querying data from the PurpleAir API requires a free [PurpleAir Developer API key](https://develop.purpleair.com/sign-in?redirectURL=%2Fdashboards%2Fkeys) linked to a Google account.
     ## Usage
     ```{r}
@@ Expand Down @@