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

Automatically generate TOC for utils readme #486

Merged
merged 22 commits into from
Feb 9, 2023
Merged

Conversation

joellabes
Copy link
Contributor

This is a:

  • bug fix PR with no breaking changes — please ensure the base branch is master
  • new functionality — please ensure the base branch is the latest dev/ branch
  • a breaking change — please ensure the base branch is the latest dev/ branch

Description & motivation

I noticed today that there were a handful of macros missing from the readme, and that's after I've also merged a few PRs to add other missing ones 😬

This fixes it forever by adding a GitHub action to generate a TOC based on the markdown headers, embedded between the <!--ts--> and <!--te--> comment tags.

Snazzy.

# Controls when the workflow will run
on:
push:
branches: [main]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe this should be all branches?

@joellabes
Copy link
Contributor Author

@dbeatty10 I forgot I never merged this! Could you have a peek?

@dbeatty10
Copy link
Contributor

@dbeatty10 I forgot I never merged this! Could you have a peek?

@joellabes There some merge conflicts that need to be resolved. Want to take a stab at resolving those and I can give this a review afterwards?

@joellabes
Copy link
Contributor Author

There some merge conflicts that need to be resolved

good to go other than the fact that redshift is still playing up!

Copy link
Contributor

@dbeatty10 dbeatty10 left a comment

Choose a reason for hiding this comment

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

Let's give it a go!

Since this is a meta change to the code base rather than an actual change, I think it's fine to merge even though there's permissions errors with Redshift right now.

@joellabes joellabes merged commit dcc9f47 into dbt-labs:main Feb 9, 2023
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.

2 participants