https://github.com/ecobee/repo-compare

A gihtub action to find every commit since the last release. With this information, it can then send a slack notification to remind users about unshipped code.
https://github.com/ecobee/repo-compare

github-actions iris springfield

Last synced: 3 days ago
JSON representation

A gihtub action to find every commit since the last release. With this information, it can then send a slack notification to remind users about unshipped code.

• Host: GitHub
• URL: https://github.com/ecobee/repo-compare
• Owner: ecobee
• License: mit
• Created: 2020-07-20T09:13:42.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-21T02:20:23.000Z (over 1 year ago)
• Last Synced: 2025-01-05T00:15:29.699Z (5 days ago)
• Topics: github-actions, iris, springfield
• Language: TypeScript
• Homepage:
• Size: 454 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# Repo Compare

Use this action to compare what's at the HEAD of your default branch, compared to what was lasted included in last release

# Usage

Create a new workflow in your repository with the following configuration

```yaml

name: 'Daily Release Workflow'

on:

  schedule:

    - cron:  '0 13 * * 1-5'

jobs:

  build:

    name: Stale Commits Notifier

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v1

        with:

          fetch-depth: 1

      - uses: ecobee/repo-compare@master

        with:

            include-prerelease: false

            default-branch: master

            slack-username: shipit

            slack-channel: '#springfield'

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

```

## Development

Install the dependencies

```bash

$ npm install

```

Build the typescript and package it for distribution

```bash

$ npm run build && npm run pack

```

Run the tests :heavy_check_mark:

```bash

$ npm test

 PASS  __tests__/main.test.ts

  Run

    ✓ calculates how many commits the repo is behind (38ms)

    ✓ sets `unreleased-commit-count (33ms)

    ✓ sets `unreleased-commit-messages (18ms)

    ✓ sets `unreleased-diff-url (15ms)

    ✓ sets `latest-release-date (16ms)

...

```

## Publish to a distribution branch

Actions are run from GitHub repos so we will checkin the packed dist folder.

Then run [ncc](https://github.com/zeit/ncc) and push the results:

```bash

$ npm run pack

$ git add dist

$ git commit -a -m "prod dependencies"

$ git push origin releases/v1

```

The action is now published! :rocket:

See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)

## Validate

You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))

```yaml

uses: ./

with:

  milliseconds: 1000

```

See the [actions tab](https://github.com/ecobee/repo-compare/actions) for runs of this action! :rocket:

## Usage:

After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action