question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Automatically comment if edits were made to the docs folder

See original GitHub issue

Hi everybody,

this came up a couple of times during the outreachy application process but I only had the time now. In short, there were some cases where edits were made to the docs folder and not the scr one. Each time, someone from core had to manually tell the author to change their contributions and I’m thinking that this could probably be automated. As I’m not sure if conda-forge wants to keep that human touch, I just wanted to preliminarily open this issue to see if there’s an openness to have this automated or not.

The easiest implementation would probably be a GitHub action like this:

on:
  pull_request_target:
    types: [opened]
    branches:
      - main
    paths:
      - 'docs/**'

jobs:
  comment:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/github-script@v4
        with:
          script: |
            github.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: 'Hi, thanks for improving the conda-forge docs. Unfortunately, the edit was made in the _docs_ folder and not in the _src_ folder. \nPlease only edit the _src_ folder as the HTML is automatically generated after merging. For more information, visit the [conda-forge docs](https://conda-forge.org/docs/user/contributing.html#improve-the-documentation).'
            })

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:2
  • Comments:16 (16 by maintainers)

github_iconTop GitHub Comments

3reactions
beckermrcommented, Oct 21, 2021

Seems fine. Might be good to tell them how to get in touch with us if they have questions. Maybe mention the gitter channel with a link?

2reactions
viniciusdccommented, Jun 30, 2021

CC @viniciusdc

I think that’s awesome!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Manage your notifications - Google Docs Editors Help
In the top right corner of the file, click Open comment history Comment and then click Notification settings . Under “Edits,” choose when...
Read more >
Check out, check in, or discard changes to files in a ...
Note: In the classic experience, find Check In on the Files tab in the ribbon. In the Comments area, add a comment that...
Read more >
Commenting and Reviewing - Microsoft Word for Dissertations
In the resulting dialog box, choose your original document on left side and the revised document on the right side (click on the...
Read more >
Commenting on a pull request - GitHub Docs
You can also suggest changes that the author of the pull request can apply ... your comment will be added on the Conversation...
Read more >
How to Share and Edit Files on Google Drive - YouTube
How to Share and Edit Files on Google DriveIt's easy to create and share files, text documents, spreadsheets, and presentations in Google ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found