Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Besides checking for .md files, also check for .github/toc.yml #7

Open
gr2m opened this issue Jan 6, 2019 · 4 comments
Open

Besides checking for .md files, also check for .github/toc.yml #7

gr2m opened this issue Jan 6, 2019 · 4 comments
Labels
enhancement New feature or request pinned

Comments

@gr2m
Copy link
Contributor

gr2m commented Jan 6, 2019

I’ve setup toc-me for https://github.com/nock/nock/. We decided to change the bullets using the configuration and I expected toc-me to update the README again, but it didn’t, because it only does when a *.md file was updated.

I wonder if you would consider checking for .github/toc.yml as well?
@welcome
Copy link

welcome bot commented Jan 6, 2019

Welcome! Thanks for opening your first issue in toc-me.

@pholleran pholleran added the enhancement New feature or request label Jan 7, 2019
@pholleran
Copy link
Owner

pholleran commented Jan 11, 2019 •
edited
Loading

@gr2m - I'm glad to see you are finding value in my little app. I like your suggestion and would welcome your thoughts on this potential approach:

  • The app checks to see if a commit includes a change to .github/toc.yml
  • If a config change is applied, the search API is used to find all markdown files in the repo
  • The app re-generates TOCs in properly configured README files

Would this address your needs?

@gr2m
Copy link
Contributor Author

gr2m commented Jan 11, 2019

Yes, that sounds great!

@stale
Copy link

stale bot commented Jan 25, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale marked as stale due to inactivity label Jan 25, 2019
@pholleran pholleran added pinned and removed stale marked as stale due to inactivity labels Jan 25, 2019
pholleran added a commit to pholleran-test-octo/toc-me that referenced this issue Sep 19, 2022
@pholleran
Commit peas (pholleran#7)
d8baa9c 
* empty commit

* Update README.md

Co-authored-by: oss-contribution-review-dev[bot] <113143629+oss-contribution-review-dev[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request pinned
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gr2m @pholleran