https://github.com/fast-facts/ng-update

A Github @actions that keeps your @angular CLI-based projects up-to-date via automated PRs based on `ng update`.
https://github.com/fast-facts/ng-update

Last synced: 3 months ago
JSON representation

A Github @actions that keeps your @angular CLI-based projects up-to-date via automated PRs based on `ng update`.

• Host: GitHub
• URL: https://github.com/fast-facts/ng-update
• Owner: fast-facts
• License: mit
• Created: 2020-04-09T00:41:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T07:53:55.000Z (4 months ago)
• Last Synced: 2024-08-28T10:11:25.813Z (4 months ago)
• Language: TypeScript
• Size: 6.01 MB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-angular - fast-facts/ng-update - A Github Action that keeps your Angular CLI-based projects up-to-date via automated PRs based on `ng update`. (Table of contents / Angular)
• trackawesomelist - fast-facts/ng-update (⭐4) - A Github Action that keeps your Angular CLI-based projects up-to-date via automated PRs based on `ng update`. (Recently Updated / [Sep 03, 2024](/content/2024/09/03/README.md))
• fucking-awesome-angular - fast-facts/ng-update - A Github Action that keeps your Angular CLI-based projects up-to-date via automated PRs based on `ng update`. (Table of contents / Angular)
• fucking-awesome-angular - fast-facts/ng-update - A Github Action that keeps your Angular CLI-based projects up-to-date via automated PRs based on `ng update`. (Table of contents / Angular)

README

        

# ng-update

A [Github Action](https://github.com/features/actions) that keeps your Angular CLI-based projects up-to-date via automated pull requests.

The action automatically runs `ng update` for you, updates @angular related dependencies and files, and creates/updates a PR with the changes.

You just have to merge the created PR back into your codebase, once ready.

## Usage

To get started, create a workflow under `.github/workflows/` folder (eg: `.github/workflows/ng-update.yml`), with the following content:

``` yaml

name: "Update Angular Action"

on: # when the action should run. Can also be a CRON or in response to external events. see https://git.io/JeBz1

  push

jobs:

  ngxUptodate:

    runs-on: ubuntu-latest

    steps:

      - name: Updating ng dependencies # the magic happens here !

        uses: fast-facts/ng-update@master

        with:

          repo-token: ${{ secrets.GITHUB_TOKEN }}

```

See [action.yml](action.yml) for complete list of options you can customize.

See [Creating a Workflow file](https://help.github.com/en/github/automating-your-workflow-with-github-actions/configuring-a-workflow#creating-a-workflow-file) for more informations about writing workflows.

## Outputs

When the action successfully runs, it produces the following outputs, that you can use them in further steps in your workflow:

* `pr-number`: the number of the PR that have been created on Github

* `ng-update-result` : an array of [PackageToUpdate](src/ngupdate.service.ts#L7), that summarizes the packages that have been updated.