/ngx-uptodate

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

Primary LanguageJavaScriptMIT LicenseMIT

ngx-uptodate

A Github Action 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/ngx-uptodate.yml), with the following content:

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: tinesoft/ngx-uptodate@master
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}

See action.yml for complete list of options you can customize. See Creating a Workflow file for more informations about writing workflows.

This is what the created PR will look like :

Example of a PR created by the ngx-uptodate action

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, that summarizes the packages that have been updated.

Contributing

Contributions are always welcome! Just fork the project, work on your feature/bug fix, and submit it. You can also contribute by creating issues. Please read the contribution guidelines for more information.

Inspiration

Kudos 👍🏾to people at Codestar and their blog post for the original idea 💡that led me to write this Github Action.

License

Copyright (c) 2020 Tine Kondo. Licensed under the MIT License (MIT)