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.

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

(docs) Add automatic generation of TOC content #1828

Merged
merged 1 commit into from
Apr 13, 2022

Conversation

AdmiringWorm
Copy link
Member

Description

This pull request adds a new GitHub Action workflow that will generate and push a new commit to the repository when it needs to update the TOC content for both the Readme.md and Contributing.md files.

Motivation and Context

To have a TOC available for the files, without the need for us to create the TOC content manually.

How Has this Been Tested?

  1. Tested on my fork to ensure that it works as expected. See AdmiringWorm@312146b as what it will create for this PR.

Screenshot (if appropriate, usually isn't needed):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Migrated package (a package has been migrated from another repository)
  • Documentation

Checklist:

  • My code follows the code style of this repository.
  • My change requires a change to documentation (this usually means the notes in the description of a package). (Will happen automatically)
  • I have updated the documentation accordingly (this usually means the notes in the description of a package).
  • I have updated the package description and it is less than 4000 characters.
  • All files are up to date with the latest Contributing Guidelines
  • The added/modified package passed install/uninstall in the chocolatey test environment.
  • The changes only affect a single package (not including meta package).

Original Location

N/A

Related Issues

Loosely related to #1754

@AdmiringWorm AdmiringWorm self-assigned this Mar 21, 2022
@AdmiringWorm AdmiringWorm requested a review from gep13 March 21, 2022 14:51
@AppVeyorBot
Copy link

✅ Package verification completed without issues. PR is now pending human review

@AppVeyorBot
Copy link

✅ Package verification completed without issues. PR is now pending human review

@AdmiringWorm AdmiringWorm requested a review from pauby April 7, 2022 13:19
@pauby
Copy link
Member

pauby commented Apr 12, 2022

I'm happy to merge this @gep13 ?

Copy link
Member

@gep13 gep13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@gep13 gep13 merged commit d31f8f9 into chocolatey-community:master Apr 13, 2022
@gep13
Copy link
Member

gep13 commented Apr 13, 2022

@AdmiringWorm thanks for getting this added!

@AdmiringWorm AdmiringWorm deleted the auto-toc branch April 13, 2022 12:04
@AdmiringWorm
Copy link
Member Author

nice, looks like it successfully updated the TOC as well: d4c4809

Wasn't sure who it would commit as though, but looks like @gep13 is the lucky winner 😆

@gep13
Copy link
Member

gep13 commented Apr 13, 2022

@AdmiringWorm said...
Wasn't sure who it would commit as though, but looks like @gep13 is the lucky winner 😆

I spotted that it was me, but I suspect going forward it will be the person doing the commit/merge into the main branch?

@AdmiringWorm
Copy link
Member Author

yeah, that is what I expect to happen at least

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants