Skip to content

Conversation

@tricki
Copy link

@tricki tricki commented Oct 1, 2023

This feature looks for references to documented components (by tag name) in inline code blocks and replaces them with links.

Inspired by the existing system for replacing types with links.

image

tr-lg added 2 commits October 1, 2023 19:10
The auto-generated type and component links didn't have a trailing slash. Since the generated paths in `kompendium.json` all have a trailing slash these links wouldn't highlight the correct type/component in the navigation.
@adrianschmidt adrianschmidt requested a review from jgroth October 16, 2023 12:02
@adrianschmidt
Copy link
Collaborator

@jgroth This sounds nice, from the description!

I'm not familiar enough with the code to be able to easily review this. Since this is a PR from a third party, make sure to be appropriately wary of potential malicious code.

Note that to run the workflows, you need to click the "Approve and run" button. This is what the GitHub docs say about this feature:

Anyone can fork a public repository, and then submit a pull request that proposes changes to the repository's GitHub Actions workflows. Although workflows from forks do not have access to sensitive data such as secrets, they can be an annoyance for maintainers if they are modified for abusive purposes.

To help prevent this, workflows on pull requests to public repositories from some outside contributors will not run automatically, and might need to be approved first. By default, all first-time contributors require approval to run workflows.

Note that the default setting is that approval is only necessary for first-time contributors, which frankly is a horrible default, in my opinion. It means that all you need to do to get access to run modified workflows in a public repo is to first get a non-malicious PR approved and merged 🤦‍♂️

I would suggest setting that config option to always require approval for all outside contributors. Under Settings -> Actions -> General:

image

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.

3 participants