Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tinesoft/ngx-uptodate

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

angular angular-cli github-actions 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/tinesoft/ngx-uptodate
Owner: tinesoft
License: mit
Created: 2019-09-23T18:02:54.000Z (over 5 years ago)
Default Branch: develop
Last Pushed: 2023-01-07T10:49:12.000Z (about 2 years ago)
Last Synced: 2024-10-01T15:05:49.464Z (4 months ago)
Topics: angular, angular-cli, github-actions, update
Language: JavaScript
Homepage:
Size: 4.32 MB
Stars: 10
Watchers: 3
Forks: 3
Open Issues: 45
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# ngx-uptodate

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/ngx-uptodate.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: tinesoft/ngx-uptodate@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.

This is what the created PR will look like :

![Example of a PR created by the ngx-uptodate action](https://cdn.jsdelivr.net/gh/tinesoft/ngx-uptodate@develop/assets/ngx-uptodate-pr-dark.png "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](src/ngupdate.service.ts#L7), 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](.github/CONTRIBUTING.md) for more information.

## Inspiration

Kudos 👍🏾to people at [Codestar](https://www.codestar.nl/) and their [blog post](https://medium.com/codestar-blog/how-we-automated-our-angular-updates-9790212aa211) for the original idea 💡that led me to write this Github Action.

## License