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

feat(pub-techdocs): add input for running actions/checkout #84

Merged

Conversation

zzehring
Copy link
Contributor

This option allows users to not run actions/checkout of the current repo. This is useful in cases of generating docs in a previous workflow job.

This option allows users to _not_ run `actions/checkout` of the current repo. This is useful in cases of generating docs in a previous workflow job.
@zzehring zzehring requested a review from a team as a code owner April 12, 2024 21:53
Copy link
Member

@iainlane iainlane left a comment

Choose a reason for hiding this comment

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

👍

hmm we should have a readme for these too, like we do for actions/

@zzehring
Copy link
Contributor Author

hmm we should have a readme for these too, like we do for actions/

Ah good idea. Not sure where we'd want to store the READMEs tho. Individual actions have their own dirs, so makes it relatively straightforward.

WDYT of a docs/ folder for this repo?

@iainlane
Copy link
Member

I like that you can see it in the GitHub UI when you browse to the directory, so that's a vote in favour of README.md.

But maybe it could be a short summary and a link to more docs elsewhere?

Anyway, that can be another issue 🙂

@zzehring
Copy link
Contributor Author

zzehring commented Apr 15, 2024

Hmmm so are you thinking a big README under .github/workflows that documents all the workflows in that directory?

I whipped up this issue to track: #90

@iainlane
Copy link
Member

Not necessarily, just that when you go to .github/workflows, something is on your screen which ends up with you at the documentation. It could be all in one .md document with folds to make it not so long, or it could be links somewhere else, whatever's best!

@zzehring
Copy link
Contributor Author

Gotcha. Yea, I think the index approach may be a good one!

@zzehring zzehring merged commit d393a41 into main Apr 15, 2024
1 check passed
@zzehring zzehring deleted the zzehring/publish-techdocs/add-input-option-checkout-repo branch April 15, 2024 22:09
This was referenced Jul 15, 2024
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