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

Append resource links to staging PRs #3454

Merged
merged 1 commit into from
Sep 27, 2021

Conversation

HebaruSan
Copy link
Member

Motivation

This staging reason explicitly mentions "the forum thread" but fails to provide it:

KSP-CKAN/CKAN-meta#2460

image

That makes these PRs somewhat annoying to review, since you have to find that link yourself (probably via the status page or by checking the metadata).

Changes

Now we append a table of the mod's resources links to the body of any staging pull request:

KSP-CKAN/CKAN-meta#2462 (manually inserted)

image

Behind the scenes:

  • We add a new, later Netkan transformer because StagingTransformer has to run before the $kref processors to be able to detect hard coded versions, but we usually only have the resources available after those transformers run
  • We use Markdown's <link> syntax for links because otherwise GitHub excludes a trailing * from the URL, which we use to abbreviate a lot of forum URLs
  • Auto-epoch PRs are affected as well, which should be fine
  • --debug prints the Markdown source of the table in case you want to see it

@HebaruSan HebaruSan added Enhancement New features or functionality Easy This is easy to fix Pull request Netkan Issues affecting the netkan data labels Sep 26, 2021
Copy link
Member

@techman83 techman83 left a comment

Choose a reason for hiding this comment

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

I think that's super sensible. Lgtm!

@HebaruSan HebaruSan merged commit 40eda03 into KSP-CKAN:master Sep 27, 2021
@HebaruSan HebaruSan deleted the feature/staging-links branch September 27, 2021 12:53
@DasSkelett
Copy link
Member

Agree, very useful; also appears to be working fine!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Easy This is easy to fix Enhancement New features or functionality Netkan Issues affecting the netkan data
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants