Skip to content

Commit

Permalink
Merge pull request #662 from github/elr/ref-github
Browse files Browse the repository at this point in the history
replace references to jonabc org with github org
  • Loading branch information
elrayle authored May 30, 2023
2 parents 0f5e5a1 + 3b0da2d commit 456c189
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/licensed.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
bundler-cache: true

# run licensed
- uses: jonabc/licensed-ci@v1
- uses: github/licensed-ci@v1
with:
# override the command to use licensed built from this repo
command: bundle exec licensed
Expand All @@ -49,5 +49,5 @@ jobs:
# the "branch" workflow creates a new branch for license file updates.
# e.g. when the action is run on main, changes are pushed to a new "main-licenses" branch

# see https://github.com/jonabc/licensed-ci for more details
# see https://github.com/github/licensed-ci for more details
workflow: branch
14 changes: 7 additions & 7 deletions docs/migrations/v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ When using licensed v3 with bundler dependencies, licensed must be installed fro

Using licensed to enumerate bundler dependencies in a GitHub Actions workflow will require ruby to be available in the actions VM environment. Ruby can be setup in an actions workflow using [ruby/setup-ruby](https://github.com/ruby/setup-ruby)(preferred) or [actions/setup-ruby](https://github.com/actions/setup-ruby)(deprecated).

If you are using licensed in a GitHub Actions workflow, [jonabc/setup-licensed](https://github.com/jonabc/setup-licensed) has been updated according to this breaking change. `setup-licensed` will install the licensed gem when ruby is available, or the licensed executable when ruby is not available. Alternatively, you can `gem install` licensed directly as an actions step.
If you are using licensed in a GitHub Actions workflow, [github/setup-licensed](https://github.com/github/setup-licensed) has been updated according to this breaking change. `setup-licensed` will install the licensed gem when ruby is available, or the licensed executable when ruby is not available. Alternatively, you can `gem install` licensed directly as an actions step.

This is an example workflow definition that runs [jonabc/licensed-ci](https://github.com/jonabc/licensed-ci)'s opinionated license compliance workflow in CI. It includes jobs that demonstrate installing licensed using
This is an example workflow definition that runs [github/licensed-ci](https://github.com/github/licensed-ci)'s opinionated license compliance workflow in CI. It includes jobs that demonstrate installing licensed using
- `gem install`
- [jonabc/setup-licensed](https://github.com/jonabc/setup-licensed)
- [github/setup-licensed](https://github.com/github/setup-licensed)
- installing when included in a bundler gem file

```yml
Expand Down Expand Up @@ -50,15 +50,15 @@ jobs:
ruby-version: "3.0"

# install licensed gem using setup-licensed
- uses: jonabc/setup-licensed@v1
- uses: github/setup-licensed@v1
with:
version: '3.x'

# install dependencies in CI environment
- run: bundle install

# run licensed-ci to cache any metadata changes and verify compliance
- uses: jonabc/licensed-ci@v1
- uses: github/licensed-ci@v1

# OR

Expand All @@ -82,7 +82,7 @@ jobs:
- run: bundle install

# run licensed-ci to cache any metadata changes and verify compliance
- uses: jonabc/licensed-ci@v1
- uses: github/licensed-ci@v1

# OR

Expand All @@ -103,7 +103,7 @@ jobs:
- run: bundle install

# run licensed-ci to cache any metadata changes and verify compliance
- uses: jonabc/licensed-ci@v1
- uses: github/licensed-ci@v1
with:
command: 'bundle exec licensed' # run licensed within the bundler context
```
2 changes: 1 addition & 1 deletion docs/sources/cocoapods.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The cocoapods source will detect dependencies when `Podfile` and `Podfile.lock` are found at an app's `source_path`. The cocoapods source uses the [cocoapods-dependencies-list](https://github.com/jonabc/cocoapods-dependencies-list) plugin to enumerate dependencies and gather metadata on each package.

**NOTE: Licensed does not install the [cocoapods-dependencies-list](https://github.com/jonanc/cocoapods-dependencies-list) plugin. Users must install the gem alongside the cocoapods gem to enumerate cocoapods dependencies.**
**NOTE: Licensed does not install the [cocoapods-dependencies-list](https://github.com/jonabc/cocoapods-dependencies-list) plugin. Users must install the gem alongside the cocoapods gem to enumerate cocoapods dependencies.**

## Evaluating dependencies from a specific target

Expand Down

0 comments on commit 456c189

Please sign in to comment.