feat: add --only-templates flag

[sadeghbarati]

For instance, check this PR in TanStack, TanStack/query#7861

The problem is when repository has too many packages the amount of scroll on the PR page will increase, adding another detail to the pkg.pr.new links conditional with a flag like --collapsed-links will help resolve this case

[Aslemammad]

Can we have onlyTemplates option that only shows the user defined options? Since that's what Seb suggested.

instead of the --collapsedLinks option.

[slorber]

What I'd like is something like this:

This PR has been continuously released. You can run its code in one of our templates:

• template-js
• template-ts

Alternatively you can try the PR code directly into your project:

Dependencies

npm add https://pkg.pr.new/@docusaurus/core@7861
npm add https://pkg.pr.new/@docusaurus/utils@7861
npm add https://pkg.pr.new/@docusaurus/theme-common@7861

---

Maybe you can consider the comment has 2 sections.

And let me activate sections and order them? For example --section templates --section dependencies

And let me pass a custom section intro message for both.

---

Full example CLI options:

--section templates
--templates-intro 'This PR has been continuously released. You can run its code in one of our templates:'
--section dependencies
--dependencies-intro 'Alternatively you can try the PR code directly into your project:'

[Aslemammad]

@slorber For now, let's only show the templates for the option --onlyTemplates

For further customization, as #173 suggested, we'd have a json output that would allow maintainers have more control over the output!

wdyt?

[slorber]

Fine with a simple option 👍

[slorber]

let me know once it's on npm

By the way what's the final comment with this new option?

Is the comment template part of this repo? I may want to fork it and customize for our own needs eventually.

[Aslemammad]

let me know once it's on npm

For sure

By the way what's the final comment with this new option?
Is the comment template part of this repo? I may want to fork it and customize for our own needs eventually.

Hmm, could you give me more context? Thank you so much❤️

[slorber]

Hmm, could you give me more context?

Hmmm not sure what to add: we agreed to keep this option simple and not have the ability to provide custom labels like my former suggestion. Can I implement custom labels myself by forking/patching this package, or is the final message being created/posted by some StackBlitz internal backend?

[Aslemammad]

Can I implement custom labels myself by forking/patching this package, or is the final message being created/posted by some StackBlitz internal backend?

Oh yea, with the #183, now you can turn comments off, get the json output and then create your own message! 😄

We will release soon.

[slorber]

@Aslemammad that probably works but looks more complicated, do you have a full github action example flow doing so?

As far as I remember it's a bit annoying in terms of security to have your action post a GitHub comment and build the code.

[Aslemammad]

As far as I remember it's a bit annoying in terms of security to have your action post a GitHub comment and build the code.

Yea, haven't looked into that, but for sure, it might have its own trade offs. But I guess that's only way we can make it extensible and let others custmize on top of it, without building many abstractions in code, which is a bit challenging.

@pngwn might want to share thoughts on this?

[pngwn]

Yes we do this a lot over on gradio. It is indeed a little more annoying but relatively straightforward.

I'll post an example flow shortly.

[pngwn]

Fwiw I do think the JSON approach is preferable to additional formatting params. This allow the most flexibility, and can even allow you to add the info to an existing CI reply rather than every service generating additional replies (which also gets very noisy).

[slorber]

Yes JSON is flexible, now if you tell me how to wire it in my CI properly and I just have to copy/paste the complex actions files, that works for me 😄

[pngwn]

Just waiting for a release and I'll post it (the old pr link is dead now). Has this been released?

[pngwn]

I'll also make a PR to the docs / readme when it is out.

[Aslemammad]

Hey not yet, we want to batch it with few other goodies and then! Sorry for that.

…

On Fri, Aug 23, 2024 at 5:12 PM pngwn ***@***.***> wrote: I'll also make a PR to the docs / readme when it is out. — Reply to this email directly, view it on GitHub <#172 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJBMICBOI6CBEYYUAD2YGJTZS433XAVCNFSM6AAAAABMRY7NYSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMBXGEZDGNZXGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[pngwn]

No worries!