https://github.com/wadackel/yarn-outdated-notifier-with-circleci

Example repository using yarn-outdated-notifier in CircleCI
https://github.com/wadackel/yarn-outdated-notifier-with-circleci

yarn-outdated-notifier

Last synced: 4 months ago
JSON representation

Example repository using yarn-outdated-notifier in CircleCI

• Host: GitHub
• URL: https://github.com/wadackel/yarn-outdated-notifier-with-circleci
• Owner: wadackel
• License: mit
• Created: 2018-02-28T14:37:11.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-02-28T15:21:06.000Z (over 8 years ago)
• Last Synced: 2025-10-18T17:37:20.178Z (8 months ago)
• Topics: yarn-outdated-notifier
• Size: 12.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: changelogs.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# yarn-outdated-notifier with CircleCI

> Example repository using [yarn-outdated-notifier](https://github.com/tsuyoshiwada/yarn-outdated-notifier) in CircleCI

## Setup CircleCI

### 1. Create GitHub Personal access tokens

Please access the page of [Personal access tokens](https://github.com/settings/tokens) and issue a token. You need the scope of `repo`.

Add the issued token to the Environment Variables of CircleCI under the name `GITHUB_API_TOKEN`.

### 2. Configuration

By using `cron` of `workflows` like below you can periodically notify outdated npm package.

```yaml

version: 2

# In order to use cron, define a job for notification.

jobs:

  notify_outdated:

    docker:

      - image: circleci/node:9.3

    working_directory: ~/repo

    steps:

      - checkout

      - run: yarn

      - run: |

          yarn outdated-notifier \

            --labels "yarn-outdated" \

            --assignees "" \

            --changelogs "changelogs.yml" \

            --api-token $GITHUB_API_TOKEN

# Define a workflow for executing job.

workflows:

  version: 2

  # ... run testing job

  notification:

    jobs:

      - notify_outdated

    triggers:

      - schedule:

          cron: "0 1 * * 4"

          filters:

            branches:

              only:

                - master

```

Please refer to [.circleci/config.yml](./.circleci/config.yml) for the setting file actually used.

## License

[MIT © tsuyoshiwada](./LICENSE)