Skip to content

Commit

Permalink
Merge pull request #413 from morungos/remove-access-tokens
Browse files Browse the repository at this point in the history
Remove remaining refs to Github access tokens
  • Loading branch information
hansmy authored Jan 10, 2024
2 parents 4a6ef5b + f243372 commit fe66c20
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 56 deletions.
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,21 +69,10 @@ remotes::install_local("~/Downloads/harsat_0.1.2.tar")
```
### Directly from Github

Alternatively, you can also install `harsat` directly from GitHub. For this to work, at the moment, you will
need a Github personal access token (the "classic" kind is best), because the repository will be private until
`harsat` is finally released. As wth bundles, this ensures that all dependencies are up-to-date, properly
downloaded and installed.

The short version is as follows:

> The `XXXX` is a Github personal access token. You only need this optional parameter while
> the `harsat` package is private because it is still under development.
> The [Getting Started](https://osparcomm.github.io/HARSAT/articles/harsat.html) guide
> has more information on how to create a personal access token.
Alternatively, you can also install `harsat` directly from GitHub.
``` r
library(remotes)
remotes::install_github("osparcomm/HARSAT@main", auth_token = 'XXXX')
remotes::install_github("osparcomm/HARSAT@main")
```

The development version is similar, but changes more often, so we only recommend this if you
Expand Down
16 changes: 3 additions & 13 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,29 +62,19 @@ remotes::install_local("~/Downloads/harsat_0.1.2.tar")
```
### Directly from Github

Alternatively, you can also install `harsat` directly from GitHub. For this to work, at the moment, you will
need a Github personal access token (the "classic" kind is best), because the repository will be private until
`harsat` is finally released. As wth bundles, this ensures that all dependencies are up-to-date, properly
downloaded and installed.

The short version is as follows:

> The `XXXX` is a Github personal access token. You only need this optional parameter while
> the `harsat` package is private because it is still under development.
> The [Getting Started](./articles/harsat.html) guide
> has more information on how to create a personal access token.
Alternatively, you can also install `harsat` directly from GitHub.

``` r
library(remotes)
remotes::install_github("osparcomm/HARSAT@main", auth_token = 'XXXX')
remotes::install_github("osparcomm/HARSAT@main")
```

The development version is similar, but changes more often, so we only recommend this if you
enjoy a more exciting time for your analysis.

``` r
library(remotes)
remotes::install_github("osparcomm/HARSAT", auth_token = 'XXXX')
remotes::install_github("osparcomm/HARSAT@develop")
```

## Example usage
Expand Down
19 changes: 4 additions & 15 deletions vignettes/harsat.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -42,32 +42,21 @@ away you go.

## Installing `harsat` directly from GitHub

To install the latest development version, use the `remotes` package:
To install the latest version, use the `remotes` package:

```r
# install.packages(remotes) -- if needed
library(remotes)
remotes::install_github("osparcomm/harsat", auth_token = 'XXXX')
remotes::install_github("osparcomm/harsat@main")
```

The stable version is similar:
The development version is similar:

```r
# install.packages("devtools")
devtools::install_github("osparcomm/HARSAT@main")
devtools::install_github("osparcomm/HARSAT@develop")
```

> Note: during development the repository is marked as private on GitHub, so you
> will need a Personal Access Token (or PAT) to access it. Follow
> [these instructions to create a Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token).
> It'll be a short string, probably beginning with `ghp_`. Put the whole
> string into the `auth_token` parameter, and that should install the
> `harsat` package directly.
>
> Please note: we strongly recommend using only "classic" personal access tokens, and avoiding
> the newer "fine grained" type. When it comes to "scopes" (permissions)
> you only need to select the `repo` permissions -- no others are needed.
> Note: many of the functions currently have a `cstm` prefix. When the
> code was originally developed, we thought of it as "contaminant time series modelling",
> which is why you get all these `cstm` prefixes. These will be removed in the
Expand Down
19 changes: 4 additions & 15 deletions vignettes/harsat.Rmd.orig
Original file line number Diff line number Diff line change
Expand Up @@ -48,32 +48,21 @@ away you go.

## Installing `harsat` directly from GitHub

To install the latest development version, use the `remotes` package:
To install the latest version, use the `remotes` package:

```r
# install.packages(remotes) -- if needed
library(remotes)
remotes::install_github("osparcomm/harsat", auth_token = 'XXXX')
remotes::install_github("osparcomm/harsat@main")
```

The stable version is similar:
The development version is similar:

```r
# install.packages("devtools")
devtools::install_github("osparcomm/HARSAT@main")
devtools::install_github("osparcomm/HARSAT@develop")
```

> Note: during development the repository is marked as private on GitHub, so you
> will need a Personal Access Token (or PAT) to access it. Follow
> [these instructions to create a Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token).
> It'll be a short string, probably beginning with `ghp_`. Put the whole
> string into the `auth_token` parameter, and that should install the
> `harsat` package directly.
>
> Please note: we strongly recommend using only "classic" personal access tokens, and avoiding
> the newer "fine grained" type. When it comes to "scopes" (permissions)
> you only need to select the `repo` permissions -- no others are needed.

> Note: many of the functions currently have a `cstm` prefix. When the
> code was originally developed, we thought of it as "contaminant time series modelling",
> which is why you get all these `cstm` prefixes. These will be removed in the
Expand Down

0 comments on commit fe66c20

Please sign in to comment.