GithubHelp home page GithubHelp logo

pozil / codetour-watch Goto Github PK

View Code? Open in Web Editor NEW
14.0 14.0 3.0 36.89 MB

GitHub Action that flags file changes that may affect CodeTour content

License: Creative Commons Zero v1.0 Universal

JavaScript 99.28% Shell 0.72%
action codetour comment pr tour

codetour-watch's People

Contributors

alejandrohdezma avatar pozil avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

codetour-watch's Issues

Resource not accessible by integration

Getting the following issue:

with:
    repo-token: ***
    silent: false
    tour-path: .tours/
    fail-on-missing-tour-updates: false
RequestError [HttpError]: Resource not accessible by integration
    at /home/runner/work/_actions/pozil/codetour-watch/v1.6.[3](https://github.com/yt-project/yt/actions/runs/3426987744/jobs/5839717454#step:3:3)/node_modules/@octokit/request/dist-node/index.js:86:21
    at processTicksAndRejections (internal/process/task_queues.js:97:5)
    at async commentPr (/home/runner/work/_actions/pozil/codetour-watch/v1.6.3/src/index.js:171:9)
    at async run (/home/runner/work/_actions/pozil/codetour-watch/v1.6.3/src/index.js:75:13) {
  status: [4](https://github.com/yt-project/yt/actions/runs/3426987744/jobs/5839717454#step:3:4)03,

Fail PR when a comment is made

Hello! ๐Ÿ‘‹

First of all, thank you so much for such a useful Action!

I started the integration in one of my projects, and while it is very useful to get the comments on the PR, the fact that the build still passes when changes are detected could lead to some issues.

One way to solve this could be by adding a new boolean flag to the action (let's say fail-on-change-detected) that, when set to true, could mark the PR as failed; that way, maintainers must fix the tour before merging the PR. Thoughts?

Once again, thank you for such a nice package!

Failed to read .tours/ directory

The action is failing to find the .tours directory either when using the default tour-path option, or explicitly setting it:

Error: Failed to read .tours/ directory: Error: ENOENT: no such file or directory, scandir '.tours/'
     at loadCodetours (/home/runner/work/_actions/pozil/codetour-watch/v1.2.0/src/index.js:209:15)

Do I need to use the checkout action in conjunction with this action?

Here is my YAML file:

name: CodeTour Watch
on:
  pull_request:
    types: 
      - opened
      - synchronize
      - reopened
    paths:
      - 'src/**'

  workflow_dispatch:

jobs:
  commands:
    runs-on: ubuntu-latest
    steps:
      - name: CodeTour
        uses: pozil/[email protected]
        with:
          repo-token: ***REDACTED***

Search for tour files in subfolders

I'm using CodeTour for a repo that also uses workspaces and nested folders for the CodeTour files.

The structure looks like this:

.tours/dotnet/http/.tours/
.tours/typescript/http/.tours/
...

Currently the action only looks for .tour files in one folder. Could that be changed so it looks in sub folders as well? Or, less ideal but workable, specify a list of folders instead?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.