- Notifications
You must be signed in to change notification settings - Fork262
docs: combine GitHub Actions docs#1011
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
docs: combine GitHub Actions docs#1011
Uh oh!
There was an error while loading.Please reload this page.
Conversation
wyardley commentedAug 30, 2024
Oh and need to update the version bump - I’ll do that in a second. |
codejedi365 commentedAug 30, 2024
When you say visually inspected, did you use the |
wyardley commentedAug 30, 2024
No, I just previewed in GH, but I'll do that, and fix the warnings / update references. |
wyardley commentedAug 30, 2024
Don't see any glaring issues now, but let me know what you think, as well as what you think of the order / layout. |
codejedi365 commentedAug 30, 2024
See the contributors doc for command usage if needed. Try to keep each PR contained so only worry about the warnings related to the part you are changing. we will do the other errors separately or whenever I get around to it. |
codejedi365 commentedAug 30, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
great! I'll take a look shortly |
a55e8b0 to02a3467Compare
codejedi365 left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
@wyardley, this is great work! Thank you for putting in the time. I'm going to add some wording adjustments on top (just my preferences) and hopefully merge it today.
I have added more "good first issue" tags and there are also the "needs-docs" labels if you would rather do documentation changes.
4f987b3 toe10ce00Comparewyardley commentedSep 4, 2024
Thanks.@codejedi365 do you want me to look over the changes, or you'll just merge when you get a chance. The updates seem fine to me. |
codejedi365 commentedSep 4, 2024
I'll just merge them, no problem, thanks. Sorry, I've caught Covid in the last few days so I haven't done much of anything since the weekend |
wyardley commentedSep 5, 2024
Yikes! Feel better 😷 |
054d9f9 to2d22cb8Comparecodejedi365 commentedSep 24, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
@wyardley, would you give this a review in the browser in case I missed something (like a link or copy/paste description error). I definitely went overboard with styling (alphabetical inputs/outputs, headings, etc.) and adding a lot more depth to the descriptions and examples. Thank you for giving me the starting point! Now that I have published the action to the marketplace I was able to simplify the |
wyardley commentedSep 24, 2024
Looks really nice... LGTM!
Got it, yes, I noticed the broken link to I would say that having it have the same name as the GH project seems like a good idea to me, unless you anticipate needing the existing name for something else? Or is that a second / different action (for |
codejedi365 commentedSep 24, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Yep, that's the link, it will exist after a marketplace publish.
I'm not sure I can change the repo name of |
wyardley commentedSep 24, 2024
Ooohhh! I didn't realize it was a different repo. Nevermind! |
a8630e4 to02f6b89Compare42eb983 to5fb5c88Comparecodejedi365 commentedSep 27, 2024
UPDATE: I have completed the rename/deprecate & release process for the |
2135c68 intopython-semantic-release:masterUh oh!
There was an error while loading.Please reload this page.
wyardley commentedSep 27, 2024
Woot! Great. Sorry to make work for you instead of saving you work, but I think this will all be really helpful to users of the program. |
codejedi365 commentedSep 27, 2024
Not a problem. I really wish the docs were more thorough and this was a moment of opportunity, and really its most necessary for newcomers that the docs are accurate and detailed. When I find discrepancies or un-intuitive items, I need to address it right away. Ultimately, it also saves me from more open issues in the future. |
Uh oh!
There was an error while loading.Please reload this page.
Purpose
Rationale
Having two separate docs with similar filenames for GitHub Actions (one for the action itself, and one on configuring it for automatic release) is a little confusing (see linked ticket).
How did you test?
Visual inspection in the browser
How to Verify