https://github.com/anilanar/moxci

Notify circleci build artifacts as github status updates.
https://github.com/anilanar/moxci

Last synced: 7 days ago
JSON representation

Notify circleci build artifacts as github status updates.

• Host: GitHub
• URL: https://github.com/anilanar/moxci
• Owner: anilanar
• License: mit
• Created: 2020-01-26T12:07:42.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-11T22:02:03.000Z (over 1 year ago)
• Last Synced: 2024-10-11T18:08:51.795Z (about 1 month ago)
• Language: TypeScript
• Size: 186 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


 Moxci


![CircleCI](https://circleci.com/gh/anilanar/moxci.svg?style=shield)

[![npm version](https://badge.fury.io/js/%40anilanar%2Fmoxci.svg)](https://badge.fury.io/js/%40anilanar%2Fmoxci.svg)

This repository is a fork of [moxci](https://github.com/moxci/moxci). Unlike the original, this one uses status checks instead of posting PR comments.

**Moxci** is a tool that will send [Github commit status](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-status-checks).

It will add a success status. The URL linked to the status is the link to the artifact.

It can be used to send a link of the latest [storybook](https://storybook.js.org/) as a status update..

# :package: Installation

```

yarn add -D @anilanar/moxci

```

# :book: Example

In order to user moxci, you will need to set up a [CircleCI](https://circleci.com/sunset1-0/) project.

In your **Project Settings** -> **Environment Variables**, enter your Circle CI API Token as `CIRCLE_TOKEN`, and Github API Token as `GITHUB_TOKEN`



In your `config.yml` for CircleCI, add commands to specify the path that contains the artifact you'd like to notify.

```yaml

- store_artifacts:

    path: path_to_artifacts

- run:

    name: Send artifact URL to Github

    command: yarn moxci path_to_artifacts/index.html

```